keychain

package module

Go to main page

Versions in this module

v0

v0.0.8

Jul 9, 2026

v0.0.7

Jul 8, 2026

v0.0.6

Jul 8, 2026

Changes in this version

+ func EcdhPublicKeyToKeychain(pubKey *ecdh.PublicKey) (string, error)

type IdentityPublicKeys

+ func (k *IdentityPublicKeys) Ed25519PublicKeyTyped() (ed25519.PublicKey, error)

+ func (k *IdentityPublicKeys) P256EcdhPublicKey() (*ecdh.PublicKey, error)

+ func (k *IdentityPublicKeys) X25519EcdhPublicKey() (*ecdh.PublicKey, error)

type Store

+ func (s *Store) DeriveSharedKeyP256(privateKeyID SecretID, peerPublicKey *ecdh.PublicKey, info []byte, keyLen int) (*memguard.LockedBuffer, error)

+ func (s *Store) DeriveSharedKeyX25519(privateKeyID SecretID, peerPublicKey *ecdh.PublicKey, info []byte, keyLen int) (*memguard.LockedBuffer, error)

+ func (s *Store) LoadEd25519PublicKey(id SecretID) (ed25519.PublicKey, error)

+ func (s *Store) LoadP256PublicKey(id SecretID) (*ecdh.PublicKey, error)

+ func (s *Store) LoadX25519PublicKey(id SecretID) (*ecdh.PublicKey, error)

v0.0.5

Jul 8, 2026

Changes in this version

+ const P256KeychainFormatByte

+ const P256KeychainSize

+ const P256KeychainTypeByte

+ func P256KeychainToPublicKey(keychainFormat string) ([]byte, error)

+ func P256PublicKeyToKeychain(pubKey []byte) (string, error)

type Store

+ func (s *Store) ExportP256PublicKey(keyID SecretID) (string, error)

+ func (s *Store) ImportP256PublicKey(keyID SecretID, keychainFormat string, label string) error

v0.0.4

Jul 8, 2026

Changes in this version

+ func Ed25519PrivateKeyToX25519(ed25519Seed []byte) ([]byte, error)

+ func Ed25519PublicKeyToX25519(ed25519PublicKey []byte) ([]byte, error)

+ func VerifySignature(publicKey []byte, signature []byte, data []byte) bool

type Identity

+ Ed25519KeyID SecretID

type IdentityPublicKeys

+ Ed25519PublicKey []byte

type KeyType

+ const KeyTypeEd25519

+ const KeyTypeEd25519Public

type Store

+ func (s *Store) AddEd25519KeyToIdentity(id string) ([]byte, error)

+ func (s *Store) CreateFullIdentity(name string) (*Identity, error)

+ func (s *Store) CreateSigningIdentity(id string, name string) (*Identity, error)

+ func (s *Store) Ed25519PublicToX25519(id SecretID) ([]byte, error)

+ func (s *Store) Ed25519ToX25519(id SecretID) ([]byte, error)

+ func (s *Store) GenerateEd25519(id SecretID, label string) (publicKey []byte, err error)

+ func (s *Store) ImportEd25519KeyToIdentity(id string, privateKey []byte) error

+ func (s *Store) Sign(id SecretID, data []byte) ([]byte, error)

+ func (s *Store) StoreEd25519PublicKey(id SecretID, publicKey []byte, label string) error

+ func (s *Store) Verify(publicKeyID SecretID, signature []byte, data []byte) (bool, error)

v0.0.3

Jul 7, 2026

v0.0.2

Jan 28, 2026

Changes in this version

+ const NaClBoxKeySize

+ const NaClBoxNonceSize

+ const NaClBoxOverhead

+ func NaClBoxDecrypt(message, peerPublicKey, privateKey []byte) ([]byte, error)

+ func NaClBoxEncrypt(plaintext, peerPublicKey, privateKey []byte) ([]byte, error)

type AddressBook

+ func (ab *AddressBook) NaClBoxDecryptFromContact(myPrivKeyID SecretID, contactID string, message []byte) ([]byte, error)

+ func (ab *AddressBook) NaClBoxDecryptFromContactWithIdentity(store *Store, identityID string, contactID string, message []byte) ([]byte, error)

+ func (ab *AddressBook) NaClBoxDecryptWithDefaultIdentity(store *Store, contactID string, message []byte) ([]byte, error)

+ func (ab *AddressBook) NaClBoxEncryptForContact(myPrivKeyID SecretID, contactID string, plaintext []byte) ([]byte, error)

+ func (ab *AddressBook) NaClBoxEncryptForContactWithIdentity(store *Store, identityID string, contactID string, plaintext []byte) ([]byte, error)

+ func (ab *AddressBook) NaClBoxEncryptWithDefaultIdentity(store *Store, contactID string, plaintext []byte) ([]byte, error)

type CipherSuite

+ const CipherNaClBox

+ func (cs CipherSuite) NonceLength() int

type Store

+ func (s *Store) CreateNahoftIdentity(name string) (*Identity, error)

+ func (s *Store) NaClBoxDecryptWithStore(privateKeyID SecretID, peerPublicKey []byte, message []byte) ([]byte, error)

+ func (s *Store) NaClBoxEncryptWithStore(privateKeyID SecretID, peerPublicKey []byte, plaintext []byte) ([]byte, error)

v0.0.1

Jan 27, 2026

Changes in this version

+ const DefaultIdentityID

+ func DecryptWith(key *memguard.LockedBuffer, ciphertext, nonce []byte, cs CipherSuite) ([]byte, error)

+ func EncryptWith(key *memguard.LockedBuffer, plaintext []byte, cs CipherSuite) (ciphertext, nonce []byte, err error)

+ type AddressBook struct

+ func NewAddressBook(store *Store) *AddressBook

+ func (ab *AddressBook) AddContact(contact *Contact) error

+ func (ab *AddressBook) AssociateOTPPad(contactID string, otpID SecretID) error

+ func (ab *AddressBook) AssociateP256Key(contactID string, keyID SecretID) error

+ func (ab *AddressBook) AssociateX25519Key(contactID string, keyID SecretID) error

+ func (ab *AddressBook) CanDecryptWith(contactID string, keyType KeyExchangeType) (bool, error)

+ func (ab *AddressBook) CanEncryptWith(contactID string, keyType KeyExchangeType) (bool, error)

+ func (ab *AddressBook) DecryptFromContact(myPrivKeyID SecretID, contactID string, ciphertext, nonce []byte, ...) ([]byte, error)

+ func (ab *AddressBook) DecryptFromContactWithIdentity(store *Store, identityID string, contactID string, ciphertext, nonce []byte, ...) ([]byte, error)

+ func (ab *AddressBook) DeleteContact(id string) error

+ func (ab *AddressBook) DeleteContactWithKeys(id string) error

+ func (ab *AddressBook) DisassociateOTPPad(contactID string) error

+ func (ab *AddressBook) EncryptForContact(myPrivKeyID SecretID, contactID string, plaintext []byte, keyType KeyType, ...) (ciphertext, nonce []byte, err error)

+ func (ab *AddressBook) EncryptForContactWithIdentity(store *Store, identityID string, contactID string, plaintext []byte, ...) (ciphertext, nonce []byte, err error)

+ func (ab *AddressBook) GetContact(id string) (*Contact, error)

+ func (ab *AddressBook) GetContactPublicKeys(id string) (*ContactPublicKeys, error)

+ func (ab *AddressBook) GetKeyStatus(contactID string, keyType KeyExchangeType) (FriendStatus, error)

+ func (ab *AddressBook) IsKeyVerified(contactID string, keyType KeyExchangeType) (bool, error)

+ func (ab *AddressBook) ListContacts() ([]*Contact, error)

+ func (ab *AddressBook) MarkInvited(contactID string, keyType KeyExchangeType) error

+ func (ab *AddressBook) MarkRequested(contactID string, keyType KeyExchangeType) error

+ func (ab *AddressBook) MarkVerified(contactID string, keyType KeyExchangeType) error

+ func (ab *AddressBook) SetKeyStatus(contactID string, keyType KeyExchangeType, status FriendStatus) error

+ func (ab *AddressBook) UpdateContact(contact *Contact) error

+ type CipherSuite string

+ const CipherAES256GCM

+ const CipherChaCha20Poly1305

+ func (cs CipherSuite) KeyLength() int

+ type Contact struct

+ CreatedAt int64

+ ID string

+ Name string

+ Notes string

+ OTPPadID SecretID

+ OTPStatus FriendStatus

+ P256KeyID SecretID

+ P256Status FriendStatus

+ UpdatedAt int64

+ X25519KeyID SecretID

+ X25519Status FriendStatus

+ type ContactPublicKeys struct

+ P256PublicKey []byte

+ X25519PublicKey []byte

+ type FriendStatus int

+ const StatusApproved

+ const StatusDefault

+ const StatusInvited

+ const StatusRequested

+ const StatusVerified

+ func (s FriendStatus) String() string

+ type Identity struct

+ CreatedAt int64

+ ID string

+ Name string

+ P256KeyID SecretID

+ UpdatedAt int64

+ X25519KeyID SecretID

+ type IdentityPublicKeys struct

+ P256PublicKey []byte

+ X25519PublicKey []byte

+ type KeyExchangeType int

+ const KeyExchangeOTP

+ const KeyExchangeP256

+ const KeyExchangeX25519

+ type KeyType string

+ const KeyTypeAES256

+ const KeyTypeChaCha20

+ const KeyTypeContact

+ const KeyTypeIdentity

+ const KeyTypeOTP

+ const KeyTypeOTPMeta

+ const KeyTypeP256

+ const KeyTypeP256Public

+ const KeyTypeX25519

+ const KeyTypeX25519Public

+ type OTPPad struct

+ CreatedAt int64

+ ID SecretID

+ Label string

+ Length int

+ Offset int

+ type OTPResult struct

+ BytesLeft int

+ BytesUsed int

+ Data []byte

+ StartOffset int

+ type SecretID string

+ type SecretMetadata struct

+ CreatedAt int64

+ ID SecretID

+ KeyType KeyType

+ Label string

+ PublicKey []byte

+ type Store struct

+ func OpenStore(path string, password []byte) (*Store, error)

+ func (s *Store) AddP256KeyToIdentity(id string) ([]byte, error)

+ func (s *Store) AddX25519KeyToIdentity(id string) ([]byte, error)

+ func (s *Store) Close()

+ func (s *Store) CreateDefaultIdentity(name string) (*Identity, error)

+ func (s *Store) CreateIdentity(id string, name string, generateP256, generateX25519 bool) (*Identity, error)

+ func (s *Store) DecryptWithDerivedKey(privateKeyID SecretID, peerPublicKey []byte, info []byte, ...) ([]byte, error)

+ func (s *Store) DefaultIdentityExists() bool

+ func (s *Store) DeleteIdentity(id string) error

+ func (s *Store) DeleteOTPPad(id SecretID) error

+ func (s *Store) DeleteSecret(id SecretID) error

+ func (s *Store) DeriveSharedKey(privateKeyID SecretID, peerPublicKey []byte, info []byte, keyLen int) (*memguard.LockedBuffer, error)

+ func (s *Store) EncryptWithDerivedKey(privateKeyID SecretID, peerPublicKey []byte, info []byte, plaintext []byte, ...) (ciphertext, nonce []byte, err error)

+ func (s *Store) GenerateP256(id SecretID, label string) (publicKey []byte, err error)

+ func (s *Store) GenerateSymmetricKey(id SecretID, label string, keyLen int) error

+ func (s *Store) GenerateX25519(id SecretID, label string) (publicKey []byte, err error)

+ func (s *Store) GetDefaultIdentity() (*Identity, error)

+ func (s *Store) GetDefaultIdentityPublicKeys() (*IdentityPublicKeys, error)

+ func (s *Store) GetIdentity(id string) (*Identity, error)

+ func (s *Store) GetIdentityPublicKeys(id string) (*IdentityPublicKeys, error)

+ func (s *Store) GetMetadata(id SecretID) (*SecretMetadata, error)

+ func (s *Store) GetOTPPadInfo(id SecretID) (*OTPPad, error)

+ func (s *Store) IdentityExists(id string) bool

+ func (s *Store) ImportP256KeyToIdentity(id string, privateKey []byte) error

+ func (s *Store) ImportX25519KeyToIdentity(id string, privateKey []byte) error

+ func (s *Store) ListIdentities() ([]*Identity, error)

+ func (s *Store) ListOTPPads() ([]OTPPad, error)

+ func (s *Store) ListSecrets() ([]SecretMetadata, error)

+ func (s *Store) LoadPublicKey(id SecretID) ([]byte, KeyType, error)

+ func (s *Store) LoadSecret(id SecretID) (*memguard.LockedBuffer, *SecretMetadata, error)

+ func (s *Store) LoadSymmetricKey(id SecretID) (*memguard.LockedBuffer, error)

+ func (s *Store) OTPBytesRemaining(id SecretID) (int, error)

+ func (s *Store) OTPDecrypt(id SecretID, ciphertext []byte) (*OTPResult, error)

+ func (s *Store) OTPDecryptBits(id SecretID, data []byte, numBits int) (*OTPResult, error)

+ func (s *Store) OTPDecryptWSPR(id SecretID, data [11]byte) (*OTPResult, [11]byte, error)

+ func (s *Store) OTPEncrypt(id SecretID, plaintext []byte) (*OTPResult, error)

+ func (s *Store) OTPEncryptBits(id SecretID, data []byte, numBits int) (*OTPResult, error)

+ func (s *Store) OTPEncryptWSPR(id SecretID, data [11]byte) (*OTPResult, [11]byte, error)

+ func (s *Store) OTPPeek(id SecretID, length int) ([]byte, error)

+ func (s *Store) OTPSetOffset(id SecretID, offset int) error

+ func (s *Store) OTPSkip(id SecretID, numBytes int) error

+ func (s *Store) SecretExists(id SecretID) bool

+ func (s *Store) StoreOTPPad(id SecretID, pad []byte, label string) error

+ func (s *Store) StoreP256PublicKey(id SecretID, publicKey []byte, label string) error

+ func (s *Store) StoreSecret(id SecretID, keyType KeyType, secret []byte, label string) error

+ func (s *Store) StoreX25519PublicKey(id SecretID, publicKey []byte, label string) error

+ func (s *Store) UpdateIdentity(identity *Identity) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL