docs, cleanup

aes_cbc_hmac.go

@@ -10,6 +10,7 @@ import (
 	"fmt"
 )
 
+// AES CBC with HMAC authenticated encryption algorithm implementation
 type AesCbcHmac struct{
 	keySizeBits int
 }

aes_gcm.go

@@ -8,6 +8,7 @@ import (
 	"jose2go/arrays"
 )
 
+// AES GCM authenticated encryption algorithm implementation
 type AesGcm struct{
 	keySizeBits int
 }

aes_gcm_kw.go

@@ -15,6 +15,7 @@ func init() {
 	RegisterJwa(&AesGcmKW{ keySizeBits: 256})
 }
 
+// AES GCM Key Wrap key management algorithm implementation
 type AesGcmKW struct {
 	keySizeBits int
 }

aeskw.go

@@ -13,6 +13,7 @@ func init() {
 	RegisterJwa(&AesKW{ keySizeBits: 256})
 }
 
+// AES Key Wrap key management algorithm implementation
 type AesKW struct {
 	keySizeBits int
 }

deflate.go

@@ -10,6 +10,7 @@ func init() {
 	RegisterJwc(new(Deflate))
 }
 
+// Deflate compression algorithm implementation
 type Deflate struct {}
 
 func (alg *Deflate) Name() string {

direct.go

@@ -8,6 +8,7 @@ func init() {
 	RegisterJwa(new(Direct))
 }
 
+// Direct (pre-shared) key management algorithm implementation
 type Direct struct{
 }
 

ecdh.go

@@ -19,6 +19,7 @@ func init() {
 	RegisterJwa(&Ecdh{directAgreement:true})
 }
 
+// Elliptic curve Diffie–Hellman key management (key agreement) algorithm implementation
 type Ecdh struct{
 	directAgreement bool
 }

ecdh_aeskw.go

@@ -6,6 +6,7 @@ func init() {
 	RegisterJwa(&EcdhAesKW{ keySizeBits: 256, aesKW: &AesKW{ keySizeBits: 256}, ecdh: &Ecdh{directAgreement:false}})
 }
 
+// Elliptic curve Diffie–Hellman with AES Key Wrap key management algorithm implementation
 type EcdhAesKW struct{
 	keySizeBits int
 	aesKW JwaAlgorithm

ecdsa_using_sha.go

@@ -16,16 +16,17 @@ func init() {
 	RegisterJws(&EcdsaUsingSha{keySizeBits: 521, hashSizeBits: 512})
 }
 
+// ECDSA signing algorithm implementation
 type EcdsaUsingSha struct{
 	keySizeBits int
 	hashSizeBits int
 }
 
 func (alg *EcdsaUsingSha) Name() string {
 	switch alg.keySizeBits {
-		case 256: return "ES256"
-		case 384: return "ES384"
-		default: return  "ES512"
+		case 256: return ES256
+		case 384: return ES384
+		default: return  ES512
 	}
 }
 

hmac_using_sha.go

@@ -11,15 +11,16 @@ func init() {
 	RegisterJws(&HmacUsingSha{keySizeBits: 512})		
 }
 
+// HMAC with SHA signing algorithm implementation
 type HmacUsingSha struct{
 	keySizeBits int
 }
 
 func (alg *HmacUsingSha) Name() string {
 	switch alg.keySizeBits {
-		case 256: return "HS256"
-		case 384: return "HS384"
-		default: return  "HS512"
+		case 256: return HS256
+		case 384: return HS384
+		default: return  HS512
 	}
 }
 

kdf/nist_sp800_56a.go

@@ -6,7 +6,9 @@ import (
 	"jose2go/arrays"
 )
 
-// DeriveConcatKDF implements NIST SP 800-56A ConcatKDF function
+// DeriveConcatKDF implements NIST SP 800-56A Concatenation Key Derivation Function. Derives 
+// key material of keydatalen bits size given Z (sharedSecret), OtherInfo (AlgorithmID | 
+// PartyUInfo | PartyVInfo | SuppPubInfo | SuppPrivInfo) and hash function
 func DeriveConcatKDF(keydatalen int, sharedSecret, algId, partyUInfo, partyVInfo, suppPubInfo, suppPrivInfo []byte, h hash.Hash) []byte {
 
 	otherInfo := arrays.Concat(algId, partyUInfo, partyVInfo, suppPubInfo, suppPrivInfo)

keys/ecc/ecc.go

@@ -1,3 +1,4 @@
+//package ecc provides helpers for creating elliptic curve leys
 package ecc
 
 import (
@@ -9,6 +10,7 @@ import (
 	"errors"
 )
 
+// ReadPublic loads ecdsa.PublicKey from given PKCS1 X509 or PKIX blobs
 func ReadPublic(raw []byte) (key *ecdsa.PublicKey,err error) {
 	var encoded *pem.Block
 
@@ -36,6 +38,7 @@ func ReadPublic(raw []byte) (key *ecdsa.PublicKey,err error) {
 	return key, nil
 }
 
+// ReadPrivate loads ecdsa.PrivateKey from given PKCS1 or PKCS8 blobs
 func ReadPrivate(raw []byte) (key *ecdsa.PrivateKey,err error) {
 	var encoded *pem.Block
 
@@ -60,12 +63,14 @@ func ReadPrivate(raw []byte) (key *ecdsa.PrivateKey,err error) {
 	return key,nil
 }
 
+// NewPublic constructs ecdsa.PublicKey from given (X,Y)
 func NewPublic(x,y []byte) (*ecdsa.PublicKey) {
 	return &ecdsa.PublicKey{ Curve: curve(len(x)), 
 							 X:new(big.Int).SetBytes(x), 
 							 Y:new(big.Int).SetBytes(y) }
 }
 
+// NewPrivate constructs ecdsa.PrivateKey from given (X,Y) and D
 func NewPrivate(x,y,d []byte) (*ecdsa.PrivateKey) {
 	return &ecdsa.PrivateKey {D:new(big.Int).SetBytes(d),
 							  PublicKey: ecdsa.PublicKey{ Curve:curve(len(x)),

keys/rsa/rsa.go

@@ -1,3 +1,4 @@
+//package Rsa provides helpers for creating rsa leys
 package Rsa
 
 import (
@@ -7,6 +8,7 @@ import (
 		"errors"
 )
 
+// ReadPrivate loads rsa.PrivateKey from PKCS1 or PKCS8 blobs 
 func ReadPrivate(raw []byte) (key *rsa.PrivateKey,err error) {	
 	var encoded *pem.Block
 
@@ -31,6 +33,7 @@ func ReadPrivate(raw []byte) (key *rsa.PrivateKey,err error) {
 	return key,nil
 }
 
+// ReadPublic loads rsa.PublicKey from PKIX or PKCS1 X509 blobs
 func ReadPublic(raw []byte) (key *rsa.PublicKey,err error)  {
 	var encoded *pem.Block
 

padding/align.go

@@ -1,9 +1,11 @@
+// package padding provides various padding algorithms
 package padding
 
 import (
 	"bytes"
 )
 
+// Align left pads given byte array with zeros till it have at least bitSize length. 
 func Align(data []byte, bitSize int) []byte {
 
 	actual:=len(data)	

padding/pkcs7.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 )
 
+// AddPkcs7 pads given byte array using pkcs7 padding schema till it has blockSize length in bytes
 func AddPkcs7(data []byte, blockSize int) []byte {
 
 	var paddingCount int
@@ -15,6 +16,7 @@ func AddPkcs7(data []byte, blockSize int) []byte {
 	return append(data, bytes.Repeat([]byte{byte(paddingCount)}, paddingCount)...)
 }
 
+// RemovePkcs7 removes pkcs7 padding from previously padded byte array
 func RemovePkcs7(padded []byte, blockSize int) []byte {	
 
 	dataLen:=len(padded)		

pbse2_hmac_aeskw.go

@@ -16,6 +16,7 @@ func init() {
 	RegisterJwa(&Pbse2HmacAesKW{keySizeBits: 256,aesKW: &AesKW{ keySizeBits: 256}})
 }
 
+// PBSE2 with HMAC key management algorithm implementation
 type Pbse2HmacAesKW struct{
 	keySizeBits int
 	aesKW JwaAlgorithm

plaintext.go

@@ -1,13 +1,14 @@
 package jose
 
+// Plaintext (no signing) signing algorithm implementation
 type Plaintext struct{}
 
 func init() {
 	RegisterJws(new(Plaintext))
 }
 
 func (alg *Plaintext) Name() string {
-	return "none"
+	return NONE
 }
 
 func (alg *Plaintext) Verify(securedInput []byte, signature []byte, key interface{}) error {

rsa_oaep.go

@@ -10,6 +10,7 @@ import (
 	"jose2go/arrays"
 )
 
+// RS-AES using OAEP key management algorithm implementation
 func init() {
 	RegisterJwa(&RsaOaep {shaSizeBits:1})
 	RegisterJwa(&RsaOaep {shaSizeBits:256})

rsa_pkcs1v15.go

@@ -11,11 +11,12 @@ func init() {
 	RegisterJwa(new(RsaPkcs1v15))
 }
 
+// RS-AES using PKCS #1 v1.5 padding key management algorithm implementation
 type RsaPkcs1v15 struct{
 }
 
 func (alg *RsaPkcs1v15) Name() string {
-	return "RSA1_5"
+	return RSA1_5
 }
 
 func (alg *RsaPkcs1v15) WrapNewKey(cekSizeBits int, key interface{}, header map[string]interface{}) (cek []byte, encryptedCek []byte, err error) {

rsa_using_sha.go

@@ -12,15 +12,16 @@ func init() {
 	RegisterJws(&RsaUsingSha{keySizeBits: 512})
 }
 
+// RSA using SHA signature algorithm implementation
 type RsaUsingSha struct{
 	keySizeBits int
 }
 
 func (alg *RsaUsingSha) Name() string {
 	switch alg.keySizeBits {
-		case 256: return "RS256"
-		case 384: return "RS384"
-		default: return  "RS512"
+		case 256: return RS256
+		case 384: return RS384
+		default: return  RS512
 	}
 }
 

rsapss_using_sha.go

@@ -12,16 +12,17 @@ func init() {
 	RegisterJws(&RsaPssUsingSha{keySizeBits: 512, saltSizeBytes: 64})
 }
 
+// RSA with PSS using SHA signing algorithm implementation
 type RsaPssUsingSha struct{
 	keySizeBits int
 	saltSizeBytes int
 }
 
 func (alg *RsaPssUsingSha) Name() string {
 	switch alg.keySizeBits {
-		case 256: return "PS256"
-		case 384: return "PS384"
-		default: return  "PS512"
+		case 256: return PS256
+		case 384: return PS384
+		default: return  PS512
 	}
 }