完善注释

Author: FishGoddess

README.en.md

@@ -42,7 +42,7 @@ $ go get -u github.com/FishGoddess/cryptox
 $ make bench
 ```
 
-_Note: Data size is 128 bytes, ecb/cbc uses pkcs7 padding, cfb/ofb/ctr is no padding._
+_Note: Data size is 128 bytes, ecb/cbc uses pkcs7 padding, cfb/ofb/ctr/gcm is no padding._
 
 ```
 goos: linux

README.md

@@ -42,7 +42,7 @@ $ go get -u github.com/FishGoddess/cryptox
 $ make bench
 ```
 
-_注：数据为 128 字节，ecb/cbc 为 pkcs7 填充，cfb/ofb/ctr 为不填充。_
+_注：数据为 128 字节，ecb/cbc 为 pkcs7 填充，cfb/ofb/ctr/gcm 为不填充。_
 
 ```
 goos: linux

_examples/rsa.key

@@ -24,6 +24,7 @@ func newBlock(key []byte) (cipher.Block, int, error) {
 	return block, blockSize, nil
 }
 
+// EncryptECB uses ecb mode to encrypt bs.
 func EncryptECB(bs []byte, key []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -52,6 +53,7 @@ func EncryptECB(bs []byte, key []byte, padding padding.Padding, encoding encodin
 	return dst, nil
 }
 
+// DecryptECB uses ecb mode to decrypt bs.
 func DecryptECB(bs []byte, key []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -82,6 +84,7 @@ func DecryptECB(bs []byte, key []byte, padding padding.Padding, encoding encodin
 	return padding.Unpad(dst, blockSize)
 }
 
+// EncryptCBC uses cbc mode to encrypt bs.
 func EncryptCBC(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -97,6 +100,7 @@ func EncryptCBC(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return dst, nil
 }
 
+// DecryptCBC uses cbc mode to decrypt bs.
 func DecryptCBC(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -114,6 +118,7 @@ func DecryptCBC(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return padding.Unpad(dst, blockSize)
 }
 
+// EncryptCFB uses cfb mode to encrypt bs.
 func EncryptCFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -129,6 +134,7 @@ func EncryptCFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return dst, nil
 }
 
+// DecryptCFB uses cfb mode to decrypt bs.
 func DecryptCFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -146,6 +152,7 @@ func DecryptCFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return padding.Unpad(dst, blockSize)
 }
 
+// EncryptOFB uses ofb mode to encrypt bs.
 func EncryptOFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -161,6 +168,7 @@ func EncryptOFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return dst, nil
 }
 
+// DecryptOFB uses ofb mode to decrypt bs.
 func DecryptOFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -178,6 +186,7 @@ func DecryptOFB(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return padding.Unpad(dst, blockSize)
 }
 
+// EncryptCTR uses ctr mode to encrypt bs.
 func EncryptCTR(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {
@@ -193,6 +202,7 @@ func EncryptCTR(bs []byte, key []byte, iv []byte, padding padding.Padding, encod
 	return dst, nil
 }
 
+// DecryptCTR uses ctr mode to decrypt bs.
 func DecryptCTR(bs []byte, key []byte, iv []byte, padding padding.Padding, encoding encoding.Encoding) ([]byte, error) {
 	block, blockSize, err := newBlock(key)
 	if err != nil {

_examples/rsa.pub

@@ -6,41 +6,17 @@ package cryptox
 
 import (
 	"encoding/base64"
-	"encoding/hex"
 	"io"
 	"os"
 )
 
 type Bytes []byte
 
-// ParseHex a hex string to bytes.
-func ParseHex(hexString string) (Bytes, error) {
-	return hex.DecodeString(hexString)
-}
-
-// ParseBase64 a base64 string to bytes.
-func ParseBase64(base64String string) (Bytes, error) {
-	return base64.StdEncoding.DecodeString(base64String)
-}
-
-// Hex returns Bytes as hex.
-func (bs Bytes) Hex() string {
-	return hex.EncodeToString(bs)
-}
-
 // Base64 returns Bytes as base64.
 func (bs Bytes) Base64() string {
 	return base64.StdEncoding.EncodeToString(bs)
 }
 
-// Clone clones bs and returns a new slice.
-func (bs Bytes) Clone() Bytes {
-	newSlice := make([]byte, len(bs))
-	copy(newSlice, bs)
-
-	return newSlice
-}
-
 func (bs Bytes) newFile(path string) (*os.File, error) {
 	flag := os.O_CREATE | os.O_EXCL | os.O_WRONLY
 	mode := os.FileMode(0644)

aes/aes.go

@@ -8,6 +8,7 @@ import "encoding/base64"
 
 type encodingBase64 struct{}
 
+// Encode encodes the byte slice with base64 encoding.
 func (encodingBase64) Encode(bs []byte) []byte {
 	enc := base64.StdEncoding
 	n := enc.EncodedLen(len(bs))
@@ -17,6 +18,7 @@ func (encodingBase64) Encode(bs []byte) []byte {
 	return buffer[:n]
 }
 
+// Decode decodes the byte slice with base64 encoding.
 func (encodingBase64) Decode(bs []byte) ([]byte, error) {
 	enc := base64.StdEncoding
 	n := enc.DecodedLen(len(bs))

bytes.go

@@ -10,7 +10,7 @@ var (
 	Base64 Encoding = encodingBase64{}
 )
 
-// Encoding encodes a byte slice to another byte slice in some way and decodes it from the byte slice.
+// Encoding transfers a byte slice to another byte slice in some way.
 type Encoding interface {
 	// Encode encodes the byte slice.
 	Encode(bs []byte) []byte

bytes/encoding/base64.go

@@ -8,6 +8,7 @@ import "encoding/hex"
 
 type encodingHex struct{}
 
+// Encode encodes the byte slice with hex encoding.
 func (encodingHex) Encode(bs []byte) []byte {
 	n := hex.EncodedLen(len(bs))
 	buffer := make([]byte, n)
@@ -16,6 +17,7 @@ func (encodingHex) Encode(bs []byte) []byte {
 	return buffer[:n]
 }
 
+// Decode decodes the byte slice with hex encoding.
 func (encodingHex) Decode(bs []byte) ([]byte, error) {
 	n := hex.DecodedLen(len(bs))
 	buffer := make([]byte, n)

bytes/encoding/encoding.go

@@ -6,10 +6,12 @@ package encoding
 
 type encodingNone struct{}
 
+// Encode returns the original byte slice.
 func (encodingNone) Encode(bs []byte) []byte {
 	return bs
 }
 
+// Decode returns the original byte slice.
 func (encodingNone) Decode(bs []byte) ([]byte, error) {
 	return bs, nil
 }