package ige

Import Path
	github.com/gotd/ige (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	    decrypt.go
	    encrypt.go
	    ige.go
Package-Level Type Names (total 4, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type IGE (interface)
		IGE satisfies the cipher.BlockMode interface from the crypto/cipher package.

		Methods (total 2, both are exported)
			( IGE) BlockSize() int
				BlockSize returns the mode's block size.

			( IGE) CryptBlocks(dst, src []byte)
				CryptBlocks encrypts or decrypts a number of blocks. The length of
				src must be a multiple of the block size. Dst and src must overlap
				entirely or not at all.
				
				If len(dst) < len(src), CryptBlocks should panic. It is acceptable
				to pass a dst bigger than src, and in that case, CryptBlocks will
				only update dst[:len(src)] and will not touch the rest of dst.
				
				Multiple calls to CryptBlocks behave as if the concatenation of
				the src buffers was passed in a single run. That is, BlockMode
				maintains state and does not reset at each CryptBlocks call.

		Implemented By (at least 6, in which 1 is exported)
			 crypto/cipher.BlockMode (interface)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			*igeDecrypter
			*igeEncrypter
			*crypto/cipher.cbcDecrypter
			*crypto/cipher.cbcEncrypter
			 crypto/tls.cbcMode (interface)
		Implements (at least one exported)
			 IGE : crypto/cipher.BlockMode
		As Outputs Of (at least 2, both are exported)
			func NewIGEDecrypter(b cipher.Block, iv []byte) IGE
			func NewIGEEncrypter(b cipher.Block, iv []byte) IGE

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type ige (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			block cipher.Block
			iv []byte
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newIGE(b cipher.Block, iv []byte) *ige

	 type igeDecrypter ige (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			block cipher.Block
			iv []byte
		Methods (total 2, both are exported)
			(*igeDecrypter) BlockSize() int
			(*igeDecrypter) CryptBlocks(dst, src []byte)
		Implements (at least 2, both are exported)
			*igeDecrypter : IGE
			*igeDecrypter : crypto/cipher.BlockMode

	 type igeEncrypter ige (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			block cipher.Block
			iv []byte
		Methods (total 2, both are exported)
			(*igeEncrypter) BlockSize() int
			(*igeEncrypter) CryptBlocks(dst, src []byte)
		Implements (at least 2, both are exported)
			*igeEncrypter : IGE
			*igeEncrypter : crypto/cipher.BlockMode


Package-Level Functions (total 6, in which 4 are exported)

	 func DecryptBlocks(block cipher.Block, iv, dst, src []byte)
		DecryptBlocks is a simple shorthand for IGE decrypting.
		Note: unlike NewIGEDecrypter, DecryptBlocks does NOT COPY iv.
		So you must not modify passed iv.

	 func EncryptBlocks(block cipher.Block, iv, dst, src []byte)
		EncryptBlocks is a simple shorthand for IGE encrypting.
		Note: unlike NewIGEEncrypter, EncryptBlocks does NOT COPY iv.
		So you must not modify passed iv.

	 func NewIGEDecrypter(b cipher.Block, iv []byte) IGE
		NewIGEDecrypter returns an IGE cipher.BlockMode which decrypts using IGE and
		the given cipher.Block.
		
		Note: iv must contain two iv values for IGE (concatenated), otherwise this
		function will panic. See ErrInvalidIV for more information.

	 func NewIGEEncrypter(b cipher.Block, iv []byte) IGE
		NewIGEEncrypter returns an IGE cipher.BlockMode which encrypts using IGE and
		the given cipher.Block.
		
		Note: iv must contain two iv values for IGE (concatenated), otherwise this
		function will panic. See ErrInvalidIV for more information.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func checkIV(b cipher.Block, iv []byte) error
	 func newIGE(b cipher.Block, iv []byte) *ige
Package-Level Variables (only one, which is exported)

	  var ErrInvalidIV error
		ErrInvalidIV is displayed as the panic message if the initialization vector
		passed to NewIGEEncrypter or NewIGEDecrypter doesn't fulfill the length
		requirements for IGE.
		
		IGE uses a two step xor process, so the first initialization vector is the
		first half, and the second initialization vector is the second half. This
		requires the initialization vector to be twice as long as the block size.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.