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

packet

package

Go to main page

Versions in this module

v1

v1.1.0-alpha.2-proton

Mar 14, 2024

v1.1.0-alpha.1-proton

Feb 28, 2024

v1.1.0-alpha.0-proton

Jan 18, 2024

v1.1.0-alpha.2

Jan 24, 2024

v1.1.0-alpha.1

Jan 24, 2024

v1.1.0-alpha.0

Jan 18, 2024

v1.0.0

Sep 23, 2023

Changes in this version

+ const BestCompression

+ const BestSpeed

+ const DefaultCompression

+ const KeyFlagAuthenticate

+ const KeyFlagCertify

+ const KeyFlagEncryptCommunications

+ const KeyFlagEncryptStorage

+ const KeyFlagGroupKey

+ const KeyFlagSign

+ const KeyFlagSplitKey

+ const NoCompression

+ const SigTypeBinary

+ const SigTypeCasualCert

+ const SigTypeCertificationRevocation

+ const SigTypeDirectSignature

+ const SigTypeGenericCert

+ const SigTypeKeyRevocation

+ const SigTypePersonaCert

+ const SigTypePositiveCert

+ const SigTypePrimaryKeyBinding

+ const SigTypeSubkeyBinding

+ const SigTypeSubkeyRevocation

+ const SigTypeText

+ const UserAttrImageSubpacket

+ func DecryptPrivateKeys(keys []*PrivateKey, passphrase []byte) error

+ func EncryptPrivateKeys(keys []*PrivateKey, passphrase []byte, config *Config) error

+ func NewOCFBDecrypter(block cipher.Block, prefix []byte, resync OCFBResyncOption) cipher.Stream

+ func NewOCFBEncrypter(block cipher.Block, randData []byte, resync OCFBResyncOption) (cipher.Stream, []byte)

+ func SerializeCompressed(w io.WriteCloser, algo CompressionAlgo, cc *CompressionConfig) (literaldata io.WriteCloser, err error)

+ func SerializeEncryptedKey(w io.Writer, pub *PublicKey, cipherFunc CipherFunction, key []byte, ...) error

+ func SerializeLiteral(w io.WriteCloser, isBinary bool, fileName string, time uint32) (plaintext io.WriteCloser, err error)

+ func SerializeSymmetricKeyEncrypted(w io.Writer, passphrase []byte, config *Config) (key []byte, err error)

+ func SerializeSymmetricKeyEncryptedReuseKey(w io.Writer, sessionKey []byte, passphrase []byte, config *Config) (err error)

+ func SerializeSymmetricallyEncrypted(w io.Writer, c CipherFunction, aeadSupported bool, cipherSuite CipherSuite, ...) (Contents io.WriteCloser, err error)

+ type AEADConfig struct

+ ChunkSize uint64

+ DefaultMode AEADMode

+ func (conf *AEADConfig) ChunkSizeByte() byte

+ func (conf *AEADConfig) Mode() AEADMode

+ type AEADEncrypted struct

+ Contents io.Reader

+ func (ae *AEADEncrypted) Decrypt(ciph CipherFunction, key []byte) (io.ReadCloser, error)

+ type AEADMode algorithm.AEADMode

+ const AEADModeEAX

+ const AEADModeGCM

+ const AEADModeOCB

+ func (mode AEADMode) IvLength() int

+ func (mode AEADMode) TagLength() int

+ type CipherFunction algorithm.CipherFunction

+ const Cipher3DES

+ const CipherAES128

+ const CipherAES192

+ const CipherAES256

+ const CipherCAST5

+ func (cipher CipherFunction) IsSupported() bool

+ func (cipher CipherFunction) KeySize() int

+ type CipherSuite struct

+ Cipher CipherFunction

+ Mode AEADMode

+ type Compressed struct

+ Body io.Reader

+ type CompressionAlgo uint8

+ const CompressionNone

+ const CompressionZIP

+ const CompressionZLIB

+ type CompressionConfig struct

+ Level int

+ type Config struct

+ AEADConfig *AEADConfig

+ Algorithm PublicKeyAlgorithm

+ CompressionConfig *CompressionConfig

+ Curve Curve

+ DefaultCipher CipherFunction

+ DefaultCompressionAlgo CompressionAlgo

+ DefaultHash crypto.Hash

+ InsecureAllowUnauthenticatedMessages bool

+ KeyLifetimeSecs uint32

+ KnownNotations map[string]bool

+ RSABits int

+ RSAPrimes []*big.Int

+ Rand io.Reader

+ S2KConfig *s2k.Config

+ S2KCount int

+ SigLifetimeSecs uint32

+ SignatureNotations []*Notation

+ SigningIdentity string

+ SigningKeyId uint64

+ Time func() time.Time

+ V5Keys bool

+ func (c *Config) AEAD() *AEADConfig

+ func (c *Config) AllowUnauthenticatedMessages() bool

+ func (c *Config) Cipher() CipherFunction

+ func (c *Config) Compression() CompressionAlgo

+ func (c *Config) CurveName() Curve

+ func (c *Config) Hash() crypto.Hash

+ func (c *Config) KeyLifetime() uint32

+ func (c *Config) KnownNotation(notationName string) bool

+ func (c *Config) Notations() []*Notation

+ func (c *Config) Now() time.Time

+ func (c *Config) PasswordHashIterations() int

+ func (c *Config) PublicKeyAlgorithm() PublicKeyAlgorithm

+ func (c *Config) RSAModulusBits() int

+ func (c *Config) Random() io.Reader

+ func (c *Config) S2K() *s2k.Config

+ func (c *Config) SigLifetime() uint32

+ func (c *Config) SigningKey() uint64

+ func (c *Config) SigningUserId() string

+ type Curve string

+ const Curve25519

+ const Curve448

+ const CurveBrainpoolP256

+ const CurveBrainpoolP384

+ const CurveBrainpoolP512

+ const CurveNistP256

+ const CurveNistP384

+ const CurveNistP521

+ const CurveSecP256k1

+ type EncryptedDataPacket interface

+ Decrypt func(CipherFunction, []byte) (io.ReadCloser, error)

+ type EncryptedKey struct

+ Algo PublicKeyAlgorithm

+ CipherFunc CipherFunction

+ Key []byte

+ KeyId uint64

+ func (e *EncryptedKey) Decrypt(priv *PrivateKey, config *Config) error

+ func (e *EncryptedKey) Serialize(w io.Writer) error

+ type LiteralData struct

+ Body io.Reader

+ FileName string

+ Format uint8

+ IsBinary bool

+ Time uint32

+ func (l *LiteralData) ForEyesOnly() bool

+ type Notation struct

+ IsCritical bool

+ IsHumanReadable bool

+ Name string

+ Value []byte

+ type OCFBResyncOption bool

+ const OCFBNoResync

+ const OCFBResync

+ type OnePassSignature struct

+ Hash crypto.Hash

+ IsLast bool

+ KeyId uint64

+ PubKeyAlgo PublicKeyAlgorithm

+ SigType SignatureType

+ func (ops *OnePassSignature) Serialize(w io.Writer) error

+ type OpaquePacket struct

+ Contents []byte

+ Reason error

+ Tag uint8

+ func (op *OpaquePacket) Parse() (p Packet, err error)

+ func (op *OpaquePacket) Serialize(w io.Writer) (err error)

+ type OpaqueReader struct

+ func NewOpaqueReader(r io.Reader) *OpaqueReader

+ func (or *OpaqueReader) Next() (op *OpaquePacket, err error)

+ type OpaqueSubpacket struct

+ Contents []byte

+ EncodedLength []byte

+ SubType uint8

+ func OpaqueSubpackets(contents []byte) (result []*OpaqueSubpacket, err error)

+ func (osp *OpaqueSubpacket) Serialize(w io.Writer) (err error)

+ type Packet interface

+ func Read(r io.Reader) (p Packet, err error)

+ type PrivateKey struct

+ Encrypted bool

+ PrivateKey interface{}

+ func NewDSAPrivateKey(creationTime time.Time, priv *dsa.PrivateKey) *PrivateKey

+ func NewDecrypterPrivateKey(creationTime time.Time, decrypter interface{}) *PrivateKey

+ func NewECDHPrivateKey(creationTime time.Time, priv *ecdh.PrivateKey) *PrivateKey

+ func NewECDSAPrivateKey(creationTime time.Time, priv *ecdsa.PrivateKey) *PrivateKey

+ func NewEdDSAPrivateKey(creationTime time.Time, priv *eddsa.PrivateKey) *PrivateKey

+ func NewElGamalPrivateKey(creationTime time.Time, priv *elgamal.PrivateKey) *PrivateKey

+ func NewRSAPrivateKey(creationTime time.Time, priv *rsa.PrivateKey) *PrivateKey

+ func NewSignerPrivateKey(creationTime time.Time, signer interface{}) *PrivateKey

+ func (pk *PrivateKey) Decrypt(passphrase []byte) error

+ func (pk *PrivateKey) Dummy() bool

+ func (pk *PrivateKey) Encrypt(passphrase []byte) error

+ func (pk *PrivateKey) EncryptWithConfig(passphrase []byte, config *Config) error

+ func (pk *PrivateKey) Serialize(w io.Writer) (err error)

+ type PublicKey struct

+ CreationTime time.Time

+ Fingerprint []byte

+ IsSubkey bool

+ KeyId uint64

+ PubKeyAlgo PublicKeyAlgorithm

+ PublicKey interface{}

+ Version int

+ func NewDSAPublicKey(creationTime time.Time, pub *dsa.PublicKey) *PublicKey

+ func NewECDHPublicKey(creationTime time.Time, pub *ecdh.PublicKey) *PublicKey

+ func NewECDSAPublicKey(creationTime time.Time, pub *ecdsa.PublicKey) *PublicKey

+ func NewEdDSAPublicKey(creationTime time.Time, pub *eddsa.PublicKey) *PublicKey

+ func NewElGamalPublicKey(creationTime time.Time, pub *elgamal.PublicKey) *PublicKey

+ func NewRSAPublicKey(creationTime time.Time, pub *rsa.PublicKey) *PublicKey

+ func (pk *PublicKey) BitLength() (bitLength uint16, err error)

+ func (pk *PublicKey) CanSign() bool

+ func (pk *PublicKey) KeyExpired(sig *Signature, currentTime time.Time) bool

+ func (pk *PublicKey) KeyIdShortString() string

+ func (pk *PublicKey) KeyIdString() string

+ func (pk *PublicKey) Serialize(w io.Writer) (err error)

+ func (pk *PublicKey) SerializeForHash(w io.Writer) error

+ func (pk *PublicKey) SerializeSignaturePrefix(w io.Writer)

+ func (pk *PublicKey) UpgradeToV5()

+ func (pk *PublicKey) VerifyKeySignature(signed *PublicKey, sig *Signature) error

+ func (pk *PublicKey) VerifyRevocationSignature(sig *Signature) (err error)

+ func (pk *PublicKey) VerifySignature(signed hash.Hash, sig *Signature) (err error)

+ func (pk *PublicKey) VerifySubkeyRevocationSignature(sig *Signature, signed *PublicKey) (err error)

+ func (pk *PublicKey) VerifyUserIdSignature(id string, pub *PublicKey, sig *Signature) (err error)

+ type PublicKeyAlgorithm uint8

+ const PubKeyAlgoDSA

+ const PubKeyAlgoECDH

+ const PubKeyAlgoECDSA

+ const PubKeyAlgoEdDSA

+ const PubKeyAlgoElGamal

+ const PubKeyAlgoRSA

+ const PubKeyAlgoRSAEncryptOnly

+ const PubKeyAlgoRSASignOnly

+ func (pka PublicKeyAlgorithm) CanEncrypt() bool

+ func (pka PublicKeyAlgorithm) CanSign() bool

+ type Reader struct

+ func NewReader(r io.Reader) *Reader

+ func (r *Reader) Next() (p Packet, err error)

+ func (r *Reader) Push(reader io.Reader) (err error)

+ func (r *Reader) Unread(p Packet)

+ type ReasonForRevocation uint8

+ const KeyCompromised

+ const KeyRetired

+ const KeySuperseded

+ const NoReason

+ type S2KType uint8

+ const S2KCHECKSUM

+ const S2KNON

+ const S2KSHA1

+ type Signature struct

+ CreationTime time.Time

+ DSASigR encoding.Field

+ DSASigS encoding.Field

+ ECDSASigR encoding.Field

+ ECDSASigS encoding.Field

+ EdDSASigR encoding.Field

+ EdDSASigS encoding.Field

+ EmbeddedSignature *Signature

+ FlagAuthenticate bool

+ FlagCertify bool

+ FlagEncryptCommunications bool

+ FlagEncryptStorage bool

+ FlagGroupKey bool

+ FlagSign bool

+ FlagSplitKey bool

+ FlagsValid bool

+ Hash crypto.Hash

+ HashSuffix []byte

+ HashTag [2]byte

+ IsPrimaryId *bool

+ IssuerFingerprint []byte

+ IssuerKeyId *uint64

+ KeyLifetimeSecs *uint32

+ Metadata *LiteralData

+ Notations []*Notation

+ PolicyURI string

+ PreferredCipherSuites [][2]uint8

+ PreferredCompression []uint8

+ PreferredHash []uint8

+ PreferredSymmetric []uint8

+ PubKeyAlgo PublicKeyAlgorithm

+ RSASignature encoding.Field

+ RevocationReason *ReasonForRevocation

+ RevocationReasonText string

+ SEIPDv1 bool

+ SEIPDv2 bool

+ SigLifetimeSecs *uint32

+ SigType SignatureType

+ SignerUserId *string

+ TrustAmount TrustAmount

+ TrustLevel TrustLevel

+ TrustRegularExpression *string

+ Version int

+ func (sig *Signature) AddMetadataToHashSuffix()

+ func (sig *Signature) CheckKeyIdOrFingerprint(pk *PublicKey) bool

+ func (sig *Signature) CrossSignKey(pub *PublicKey, hashKey *PublicKey, signingKey *PrivateKey, config *Config) error

+ func (sig *Signature) RevokeKey(pub *PublicKey, priv *PrivateKey, config *Config) error

+ func (sig *Signature) RevokeSubkey(pub *PublicKey, priv *PrivateKey, config *Config) error

+ func (sig *Signature) Serialize(w io.Writer) (err error)

+ func (sig *Signature) SigExpired(currentTime time.Time) bool

+ func (sig *Signature) Sign(h hash.Hash, priv *PrivateKey, config *Config) (err error)

+ func (sig *Signature) SignKey(pub *PublicKey, priv *PrivateKey, config *Config) error

+ func (sig *Signature) SignUserId(id string, pub *PublicKey, priv *PrivateKey, config *Config) error

+ type SignatureType uint8

+ type SymmetricKeyEncrypted struct

+ CipherFunc CipherFunction

+ Mode AEADMode

+ Version int

+ func (ske *SymmetricKeyEncrypted) Decrypt(passphrase []byte) ([]byte, CipherFunction, error)

+ type SymmetricallyEncrypted struct

+ ChunkSizeByte byte

+ Cipher CipherFunction

+ Contents io.Reader

+ IntegrityProtected bool

+ Mode AEADMode

+ Salt [aeadSaltSize]byte

+ Version int

+ func (se *SymmetricallyEncrypted) Decrypt(c CipherFunction, key []byte) (io.ReadCloser, error)

+ type TrustAmount uint8

+ type TrustLevel uint8

+ type UserAttribute struct

+ Contents []*OpaqueSubpacket

+ func NewUserAttribute(contents ...*OpaqueSubpacket) *UserAttribute

+ func NewUserAttributePhoto(photos ...image.Image) (uat *UserAttribute, err error)

+ func (uat *UserAttribute) ImageData() (imageData [][]byte)

+ func (uat *UserAttribute) Serialize(w io.Writer) (err error)

+ type UserId struct

+ Comment string

+ Email string

+ Id string

+ Name string

+ func NewUserId(name, comment, email string) *UserId

+ func (uid *UserId) Serialize(w io.Writer) error

v1.0.0-proton

Jan 18, 2024