Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jess

package module

Go to main page

Versions in this module

v0

v0.3.3

Dec 19, 2023

Changes in this version

+ var SuiteCompleteV2 = registerSuite(&Suite{ ... })

+ var SuiteKeyV2 = registerSuite(&Suite{ ... })

+ var SuitePasswordV2 = registerSuite(&Suite{ ... })

+ var SuiteRcptOnlyV2 = registerSuite(&Suite{ ... })

+ var SuiteSignFileV2 = registerSuite(&Suite{ ... })

+ var SuiteSignV2 = registerSuite(&Suite{ ... })

+ var SuiteWireV2 = registerSuite(&Suite{ ... })

v0.3.2

Oct 25, 2023

v0.3.1

Oct 11, 2022

v0.3.0

Sep 29, 2022

Changes in this version

+ const ExportEnvelopeKeyword

+ const ExportEnvelopePrefix

+ const ExportKeyKeyword

+ const ExportKeyPrefix

+ const ExportRecipientKeyword

+ const ExportRecipientPrefix

+ const ExportSenderKeyword

+ const ExportSenderPrefix

+ var SuiteSignFile = SuiteSignFileV1

+ var SuiteSignFileV1 = registerSuite(&Suite{ ... })

type Envelope

+ func EnvelopeFromBase58(base58Encoded string) (*Envelope, error)

+ func EnvelopeFromBytes(data []byte) (*Envelope, error)

+ func EnvelopeFromTextFormat(textFormat string) (*Envelope, error)

+ func (e *Envelope) CleanSignets()

+ func (e *Envelope) Export(short bool) (textFormat string, err error)

+ func (e *Envelope) ToBase58() (string, error)

+ func (e *Envelope) ToBytes() ([]byte, error)

type Signet

+ func KeyFromTextFormat(textFormat string) (*Signet, error)

+ func RecipientFromTextFormat(textFormat string) (*Signet, error)

+ func SenderFromTextFormat(textFormat string) (*Signet, error)

+ func SignetFromBase58(base58Encoded string) (*Signet, error)

+ func SignetFromBytes(data []byte) (*Signet, error)

+ func (signet *Signet) Backup(short bool) (textFormat string, err error)

+ func (signet *Signet) Export(short bool) (textFormat string, err error)

+ func (signet *Signet) ToBase58() (string, error)

+ func (signet *Signet) ToBytes() ([]byte, error)

v0.2.3

Sep 27, 2021

v0.2.2

Jul 7, 2021

v0.2.1

Aug 6, 2020

Changes in this version

+ const Confidentiality

+ const FilterAny

+ const FilterRecipientOnly

+ const FilterSignetOnly

+ const Integrity

+ const RecipientAuthentication

+ const SenderAuthentication

+ const SignetSchemeKey

+ const SignetSchemePassword

+ const SuiteStatusDeprecated

+ const SuiteStatusPermitted

+ const SuiteStatusRecommended

+ var ErrAuthenticityViolation = errors.New("authenticity violation")

+ var ErrConfidentialityViolation = errors.New("confidentiality violation")

+ var ErrEnvelopeNotFound = errors.New("could not find envelope")

+ var ErrIncompatibleFileFormatVersion = errors.New("incompatible file format version")

+ var ErrIncompatibleWireFormatVersion = errors.New("incompatible wire format version")

+ var ErrInsufficientRandom = errors.New("not enough random data available from source")

+ var ErrIntegrityViolation = errors.New("integrity violation")

+ var ErrSignetNotFound = errors.New("could not find signet")

+ var RecommendedNetwork = []string

+ var RecommendedSigning = []string

+ var RecommendedStorageKey = []string

+ var RecommendedStoragePassword = []string

+ var RecommendedStorageRecipient = []string

+ var SuiteComplete = SuiteCompleteV1

+ var SuiteCompleteV1 = registerSuite(&Suite{ ... })

+ var SuiteKey = SuiteKeyV1

+ var SuiteKeyV1 = registerSuite(&Suite{ ... })

+ var SuitePassword = SuitePasswordV1

+ var SuitePasswordV1 = registerSuite(&Suite{ ... })

+ var SuiteRcptOnly = SuiteRcptOnlyV1

+ var SuiteRcptOnlyV1 = registerSuite(&Suite{ ... })

+ var SuiteSign = SuiteSignV1

+ var SuiteSignV1 = registerSuite(&Suite{ ... })

+ var SuiteWire = SuiteWireV1

+ var SuiteWireV1 = registerSuite(&Suite{ ... })

+ func Burn(data ...[]byte)

+ func CalculatePasswordSecurityLevel(password string, iterations int) int

+ func Random() io.Reader

+ func RandomBytes(n int) ([]byte, error)

+ func SetCustomRNG(randReader io.Reader)

+ func SetDefaultKeySize(sizeInBytes int)

+ func SetMinimumSecurityLevel(securityLevel int)

+ func SetPasswordCallbacks(createPassword func(signet *Signet, minSecurityLevel int) error, ...)

+ func SuitesMap() map[string]*Suite

+ type Envelope struct

+ Name string

+ Recipients []*Signet

+ Secrets []*Signet

+ SecurityLevel int

+ Senders []*Signet

+ SuiteID string

+ Version uint8

+ func NewUnconfiguredEnvelope() *Envelope

+ func (e *Envelope) Check(trustStore TrustStore) error

+ func (e *Envelope) Correspondence(trustStore TrustStore) (*Session, error)

+ func (e *Envelope) LoadSuite() error

+ func (e *Envelope) LoopRecipients(scheme string, fn func(*Signet) error) error

+ func (e *Envelope) LoopSecrets(scheme string, fn func(*Signet) error) error

+ func (e *Envelope) LoopSenders(scheme string, fn func(*Signet) error) error

+ func (e *Envelope) PrepareSignets(storage TrustStore) error

+ func (e *Envelope) ReloadSuite() error

+ func (e *Envelope) Suite() *Suite

+ func (e *Envelope) WireCorrespondence(trustStore TrustStore) (*Session, error)

+ type Helper struct

+ func (h *Helper) Burn(data ...[]byte)

+ func (h *Helper) DefaultSymmetricKeySize() int

+ func (h *Helper) FillNewSessionKey(key []byte) error

+ func (h *Helper) MaxSecurityLevel() int

+ func (h *Helper) NewSessionKey() ([]byte, error)

+ func (h *Helper) NewSessionNonce() ([]byte, error)

+ func (h *Helper) Random() io.Reader

+ func (h *Helper) RandomBytes(n int) ([]byte, error)

+ func (h *Helper) SecurityLevel() int

+ type Letter struct

+ ApplyKeys bool

+ Data []byte

+ Keys []*Seal

+ Mac []byte

+ Nonce []byte

+ Signatures []*Seal

+ SuiteID string

+ Version uint8

+ func LetterFromDSD(data []byte) (*Letter, error)

+ func LetterFromFileFormat(c *container.Container) (*Letter, error)

+ func LetterFromJSON(data []byte) (*Letter, error)

+ func LetterFromWire(c *container.Container) (*Letter, error)

+ func LetterFromWireData(data []byte) (*Letter, error)

+ func (letter *Letter) Envelope(requirements *Requirements) (*Envelope, error)

+ func (letter *Letter) Open(requirements *Requirements, trustStore TrustStore) ([]byte, error)

+ func (letter *Letter) ToDSD(dsdFormat uint8) ([]byte, error)

+ func (letter *Letter) ToFileFormat() (*container.Container, error)

+ func (letter *Letter) ToJSON() ([]byte, error)

+ func (letter *Letter) ToWire() (*container.Container, error)

+ func (letter *Letter) Verify(requirements *Requirements, trustStore TrustStore) error

+ func (letter *Letter) WireCorrespondence(trustStore TrustStore) (*Session, error)

+ type MemTrustStore struct

+ func NewMemTrustStore() *MemTrustStore

+ func (mts *MemTrustStore) DeleteSignet(id string, recipient bool) error

+ func (mts *MemTrustStore) GetSignet(id string, recipient bool) (*Signet, error)

+ func (mts *MemTrustStore) SelectSignets(filter uint8, schemes ...string) ([]*Signet, error)

+ func (mts *MemTrustStore) StoreSignet(signet *Signet) error

+ type Requirements struct

+ func NewRequirements() *Requirements

+ func ParseRequirementsFromNoSpec(no string) (*Requirements, error)

+ func (requirements *Requirements) Add(attribute uint8) *Requirements

+ func (requirements *Requirements) CheckComplianceTo(requirement *Requirements) error

+ func (requirements *Requirements) Empty() bool

+ func (requirements *Requirements) Has(attribute uint8) bool

+ func (requirements *Requirements) Remove(attribute uint8) *Requirements

+ func (requirements *Requirements) SerializeToNoSpec() string

+ func (requirements *Requirements) ShortString() string

+ func (requirements *Requirements) String() string

+ type Seal struct

+ ID string

+ Scheme string

+ Value []byte

+ type Session struct

+ DefaultSymmetricKeySize int

+ SecurityLevel int

+ func (s *Session) Close(data []byte) (*Letter, error)

+ func (s *Session) NonceSize() int

+ func (s *Session) Open(letter *Letter) ([]byte, error)

+ func (s *Session) Server()

+ func (s *Session) Verify(letter *Letter) error

+ type Signet struct

+ ID string

+ Info *SignetInfo

+ Key []byte

+ Protection *Envelope

+ Public bool

+ Scheme string

+ Signature *Letter

+ Version uint8

+ func GenerateSignet(toolID string, securityLevel int) (*Signet, error)

+ func NewSignetBase(tool *tools.Tool) *Signet

+ func (signet *Signet) AsRecipient() (*Signet, error)

+ func (signet *Signet) AssignUUID() error

+ func (signet *Signet) Burn() error

+ func (signet *Signet) GenerateKey() error

+ func (signet *Signet) GetStoredKey() (key []byte, public bool)

+ func (signet *Signet) LoadKey() error

+ func (signet *Signet) PrivateKey() crypto.PrivateKey

+ func (signet *Signet) PublicKey() crypto.PublicKey

+ func (signet *Signet) SetLoadedKeys(pubKey crypto.PublicKey, privKey crypto.PrivateKey)

+ func (signet *Signet) SetStoredKey(key []byte, public bool)

+ func (signet *Signet) StoreKey() error

+ func (signet *Signet) Tool() (*tools.Tool, error)

+ func (signet *Signet) Verify() error

+ type SignetInfo struct

+ Created time.Time

+ Details [][2]string

+ Expires time.Time

+ Name string

+ Owner string

+ type Suite struct

+ ID string

+ Provides *Requirements

+ SecurityLevel int

+ Status uint8

+ Tools []string

+ func GetSuite(suiteID string) (suite *Suite, ok bool)

+ func Suites() []*Suite

+ type TrustStore interface

+ GetSignet func(id string, recipient bool) (*Signet, error)

+ type WireSession struct