Package: crypto/cipher

package cipher Import Path crypto/cipher (on golang.org and go.dev) Dependency Relation imports 5 packages, and imported by 8 packages Involved Source Files cbc.go cfb.go d-> cipher.go ctr.go gcm.go io.go ofb.go xor_amd64.go xor_amd64.s Exported Type Names

type AEAD (interface) AEAD is a cipher mode providing authenticated encryption with associated data. For a description of the methodology, see https://en.wikipedia.org/wiki/Authenticated_encryption Exported Methods (4) (T) NonceSize() int (T) Open(dst, nonce, ciphertext, additionalData []byte) ([]byte, error) (T) Overhead() int (T) Seal(dst, nonce, plaintext, additionalData []byte) []byte As Outputs Of (5+) func NewGCM(cipher Block) (AEAD, error) func NewGCMWithNonceSize(cipher Block, size int) (AEAD, error) func NewGCMWithTagSize(cipher Block, tagSize int) (AEAD, error) func vendor/golang.org/x/crypto/chacha20poly1305.New(key []byte) (AEAD, error) func vendor/golang.org/x/crypto/chacha20poly1305.NewX(key []byte) (AEAD, error)

type Block (interface) A Block represents an implementation of block cipher using a given key. It provides the capability to encrypt or decrypt individual blocks. The mode implementations extend that capability to streams of blocks. Exported Methods (3) (T) BlockSize() int (T) Decrypt(dst, src []byte) (T) Encrypt(dst, src []byte) As Outputs Of (3+) func crypto/aes.NewCipher(key []byte) (Block, error) func crypto/des.NewCipher(key []byte) (Block, error) func crypto/des.NewTripleDESCipher(key []byte) (Block, error) As Inputs Of (9+) func NewCBCDecrypter(b Block, iv []byte) BlockMode func NewCBCEncrypter(b Block, iv []byte) BlockMode func NewCFBDecrypter(block Block, iv []byte) Stream func NewCFBEncrypter(block Block, iv []byte) Stream func NewCTR(block Block, iv []byte) Stream func NewGCM(cipher Block) (AEAD, error) func NewGCMWithNonceSize(cipher Block, size int) (AEAD, error) func NewGCMWithTagSize(cipher Block, tagSize int) (AEAD, error) func NewOFB(b Block, iv []byte) Stream

type BlockMode (interface) A BlockMode represents a block cipher running in a block-based mode (CBC, ECB etc). Exported Methods (2) (T) BlockSize() int (T) CryptBlocks(dst, src []byte) As Outputs Of (2+) func NewCBCDecrypter(b Block, iv []byte) BlockMode func NewCBCEncrypter(b Block, iv []byte) BlockMode

type Stream (interface) A Stream represents a stream cipher. One Exported Method (T) XORKeyStream(dst, src []byte) Implemented By (2+) crypto/rc4.(*Cipher) vendor/golang.org/x/crypto/chacha20.(*Cipher) As Outputs Of (4+) func NewCFBDecrypter(block Block, iv []byte) Stream func NewCFBEncrypter(block Block, iv []byte) Stream func NewCTR(block Block, iv []byte) Stream func NewOFB(b Block, iv []byte) Stream

type StreamReader (struct) StreamReader wraps a Stream into an io.Reader. It calls XORKeyStream to process each slice of data which passes through. Exported Fields (2) R io.Reader S Stream One Exported Method (T) Read(dst []byte) (n int, err error) Implements (1+) T : io.Reader

type StreamWriter (struct) StreamWriter wraps a Stream into an io.Writer. It calls XORKeyStream to process each slice of data which passes through. If any Write call returns short then the StreamWriter is out of sync and must be discarded. A StreamWriter has no internal buffering; Close does not need to be called to flush write data. Exported Fields (3) Err error S Stream W io.Writer Exported Methods (2) (T) Close() error (T) Write(src []byte) (n int, err error) Implements (3+) T : io.Closer T : io.WriteCloser T : io.Writer

Exported Values

func NewCBCDecrypter(b Block, iv []byte) BlockMode NewCBCDecrypter returns a BlockMode which decrypts in cipher block chaining mode, using the given Block. The length of iv must be the same as the Block's block size and must match the iv used to encrypt the data.

func NewCBCEncrypter(b Block, iv []byte) BlockMode NewCBCEncrypter returns a BlockMode which encrypts in cipher block chaining mode, using the given Block. The length of iv must be the same as the Block's block size.

func NewCFBDecrypter(block Block, iv []byte) Stream NewCFBDecrypter returns a Stream which decrypts with cipher feedback mode, using the given Block. The iv must be the same length as the Block's block size.

func NewCFBEncrypter(block Block, iv []byte) Stream NewCFBEncrypter returns a Stream which encrypts with cipher feedback mode, using the given Block. The iv must be the same length as the Block's block size.

func NewCTR(block Block, iv []byte) Stream NewCTR returns a Stream which encrypts/decrypts using the given Block in counter mode. The length of iv must be the same as the Block's block size.

func NewGCM(cipher Block) (AEAD, error) NewGCM returns the given 128-bit, block cipher wrapped in Galois Counter Mode with the standard nonce length. In general, the GHASH operation performed by this implementation of GCM is not constant-time. An exception is when the underlying Block was created by aes.NewCipher on systems with hardware support for AES. See the crypto/aes package documentation for details.

func NewGCMWithNonceSize(cipher Block, size int) (AEAD, error) NewGCMWithNonceSize returns the given 128-bit, block cipher wrapped in Galois Counter Mode, which accepts nonces of the given length. The length must not be zero. Only use this function if you require compatibility with an existing cryptosystem that uses non-standard nonce lengths. All other users should use NewGCM, which is faster and more resistant to misuse.

func NewGCMWithTagSize(cipher Block, tagSize int) (AEAD, error) NewGCMWithTagSize returns the given 128-bit, block cipher wrapped in Galois Counter Mode, which generates tags with the given length. Tag sizes between 12 and 16 bytes are allowed. Only use this function if you require compatibility with an existing cryptosystem that uses non-standard tag lengths. All other users should use NewGCM, which is more resistant to misuse.

func NewOFB(b Block, iv []byte) Stream NewOFB returns a Stream that encrypts or decrypts using the block cipher b in output feedback mode. The initialization vector iv's length must be equal to b's block size.