README
¶
Documentation
¶
Overview ¶
Package encryption contains the message encryption schemes defined in NIP-04 and NIP-44, used for encrypting the content of nostr messages.
Index ¶
- Constants
- Variables
- func CalcPadding(sLen int) (l int)
- func ComputeSharedSecret(pkh, skh string) (sharedSecret []byte, err error)
- func Decrypt(b64ciphertextWrapped string, conversationKey []byte) (plaintext string, err error)
- func DecryptNip4(content string, key []byte) (msg []byte, err error)deprecated
- func Encrypt(plaintext string, conversationKey []byte, applyOptions ...func(opts *Opts)) (cipherString string, err error)
- func EncryptNip4(msg string, key []byte) (ct []byte, err error)deprecated
- func GenerateConversationKey(pkh, skh string) (ck []byte, err error)
- func WithCustomNonce(salt []byte) func(opts *Opts)
- type Opts
Constants ¶
const ( MinPlaintextSize = 0x0001 // 1b msg => padded to 32b MaxPlaintextSize = 0xffff // 65535 (64kb-1) => padded to 64kb )
Variables ¶
var WithCustomSalt = WithCustomNonce
Deprecated: use WithCustomNonce instead of WithCustomSalt, so the naming is less confusing
Functions ¶
func CalcPadding ¶
CalcPadding creates padding for the message payload that is precisely a power of two in order to reduce the chances of plaintext attack. This is plainly retarded because it could blow out the message size a lot when just a random few dozen bytes and a length prefix would achieve the same result.
func ComputeSharedSecret ¶
ComputeSharedSecret returns a shared secret key used to encrypt messages. The private and public keys should be hex encoded. Uses the Diffie-Hellman key exchange (ECDH) (RFC 4753).
func Decrypt ¶
Decrypt data that has been encoded using a provided symmetric conversation key using NIP-44 encryption (chacha20 cipher stream and sha256 HMAC).
func DecryptNip4
deprecated
func Encrypt ¶
func Encrypt( plaintext string, conversationKey []byte, applyOptions ...func(opts *Opts), ) ( cipherString string, err error, )
Encrypt data using a provided symmetric conversation key using NIP-44 encryption (chacha20 cipher stream and sha256 HMAC).
func EncryptNip4
deprecated
EncryptNip4 encrypts message with key using aes-256-cbc. key should be the shared secret generated by ComputeSharedSecret.
Returns: base64(encrypted_bytes) + "?iv=" + base64(initialization_vector).
Deprecated: upgrade to using Decrypt with the NIP-44 algorithm.
func GenerateConversationKey ¶
GenerateConversationKey performs an ECDH key generation hashed with the nip-44-v2 using hkdf.
func WithCustomNonce ¶
WithCustomNonce enables using a custom nonce (salt) instead of using the system crypto/rand entropy source.
Source Files