1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
// Copyright 2018 Thales e-Security, Inc
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package crypto11
import (
"errors"
"hash"
"github.com/miekg/pkcs11"
)
const (
// NFCK_VENDOR_NCIPHER distinguishes nShield vendor-specific mechanisms.
NFCK_VENDOR_NCIPHER = 0xde436972
// CKM_NCIPHER is the base for nShield vendor-specific mechanisms.
CKM_NCIPHER = (pkcs11.CKM_VENDOR_DEFINED | NFCK_VENDOR_NCIPHER)
// CKM_NC_MD5_HMAC_KEY_GEN is the nShield-specific HMACMD5 key-generation mechanism
CKM_NC_MD5_HMAC_KEY_GEN = (CKM_NCIPHER + 0x6)
// CKM_NC_SHA_1_HMAC_KEY_GEN is the nShield-specific HMACSHA1 key-generation mechanism
CKM_NC_SHA_1_HMAC_KEY_GEN = (CKM_NCIPHER + 0x3)
// CKM_NC_SHA224_HMAC_KEY_GEN is the nShield-specific HMACSHA224 key-generation mechanism
CKM_NC_SHA224_HMAC_KEY_GEN = (CKM_NCIPHER + 0x24)
// CKM_NC_SHA256_HMAC_KEY_GEN is the nShield-specific HMACSHA256 key-generation mechanism
CKM_NC_SHA256_HMAC_KEY_GEN = (CKM_NCIPHER + 0x25)
// CKM_NC_SHA384_HMAC_KEY_GEN is the nShield-specific HMACSHA384 key-generation mechanism
CKM_NC_SHA384_HMAC_KEY_GEN = (CKM_NCIPHER + 0x26)
// CKM_NC_SHA512_HMAC_KEY_GEN is the nShield-specific HMACSHA512 key-generation mechanism
CKM_NC_SHA512_HMAC_KEY_GEN = (CKM_NCIPHER + 0x27)
)
type hmacImplementation struct {
// PKCS#11 session to use
session *pkcs11Session
// Signing key
key *SecretKey
// Hash size
size int
// Block size
blockSize int
// PKCS#11 mechanism information
mechDescription []*pkcs11.Mechanism
// Cleanup function
cleanup func()
// Count of updates
updates uint64
// Result, or nil if we don't have the answer yet
result []byte
}
type hmacInfo struct {
size int
blockSize int
general bool
}
var hmacInfos = map[int]*hmacInfo{
pkcs11.CKM_MD5_HMAC: {20, 64, false},
pkcs11.CKM_MD5_HMAC_GENERAL: {20, 64, true},
pkcs11.CKM_SHA_1_HMAC: {20, 64, false},
pkcs11.CKM_SHA_1_HMAC_GENERAL: {20, 64, true},
pkcs11.CKM_SHA224_HMAC: {28, 64, false},
pkcs11.CKM_SHA224_HMAC_GENERAL: {28, 64, true},
pkcs11.CKM_SHA256_HMAC: {32, 64, false},
pkcs11.CKM_SHA256_HMAC_GENERAL: {32, 64, true},
pkcs11.CKM_SHA384_HMAC: {48, 64, false},
pkcs11.CKM_SHA384_HMAC_GENERAL: {48, 64, true},
pkcs11.CKM_SHA512_HMAC: {64, 128, false},
pkcs11.CKM_SHA512_HMAC_GENERAL: {64, 128, true},
pkcs11.CKM_SHA512_224_HMAC: {28, 128, false},
pkcs11.CKM_SHA512_224_HMAC_GENERAL: {28, 128, true},
pkcs11.CKM_SHA512_256_HMAC: {32, 128, false},
pkcs11.CKM_SHA512_256_HMAC_GENERAL: {32, 128, true},
pkcs11.CKM_RIPEMD160_HMAC: {20, 64, false},
pkcs11.CKM_RIPEMD160_HMAC_GENERAL: {20, 64, true},
}
// errHmacClosed is called if an HMAC is updated after it has finished.
var errHmacClosed = errors.New("already called Sum()")
// NewHMAC returns a new HMAC hash using the given PKCS#11 mechanism
// and key.
// length specifies the output size, for _GENERAL mechanisms.
//
// If the mechanism is not in the built-in list of known mechanisms then the
// Size() function will return whatever length was, even if it is wrong.
// BlockSize() will always return 0 in this case.
//
// The Reset() method is not implemented.
// After Sum() is called no new data may be added.
func (key *SecretKey) NewHMAC(mech int, length int) (hash.Hash, error) {
hi := hmacImplementation{
key: key,
}
var params []byte
if info, ok := hmacInfos[mech]; ok {
hi.blockSize = info.blockSize
if info.general {
hi.size = length
params = ulongToBytes(uint(length))
} else {
hi.size = info.size
}
} else {
hi.size = length
}
hi.mechDescription = []*pkcs11.Mechanism{pkcs11.NewMechanism(uint(mech), params)}
if err := hi.initialize(); err != nil {
return nil, err
}
return &hi, nil
}
func (hi *hmacImplementation) initialize() (err error) {
session, err := hi.key.context.getSession()
if err != nil {
return err
}
hi.session = session
hi.cleanup = func() {
hi.key.context.pool.Put(session)
hi.session = nil
}
if err = hi.session.ctx.SignInit(hi.session.handle, hi.mechDescription, hi.key.handle); err != nil {
hi.cleanup()
return
}
hi.updates = 0
hi.result = nil
return
}
func (hi *hmacImplementation) Write(p []byte) (n int, err error) {
if hi.result != nil {
if len(p) > 0 {
err = errHmacClosed
}
return
}
if err = hi.session.ctx.SignUpdate(hi.session.handle, p); err != nil {
return
}
hi.updates++
n = len(p)
return
}
func (hi *hmacImplementation) Sum(b []byte) []byte {
if hi.result == nil {
var err error
if hi.updates == 0 {
// http://docs.oasis-open.org/pkcs11/pkcs11-base/v2.40/os/pkcs11-base-v2.40-os.html#_Toc322855304
// We must ensure that C_SignUpdate is called _at least once_.
if err = hi.session.ctx.SignUpdate(hi.session.handle, []byte{}); err != nil {
panic(err)
}
}
hi.result, err = hi.session.ctx.SignFinal(hi.session.handle)
hi.cleanup()
if err != nil {
panic(err)
}
}
return append(b, hi.result...)
}
func (hi *hmacImplementation) Reset() {
hi.Sum(nil) // Clean up
// Assign the error to "_" to indicate we are knowingly ignoring this. It may have been
// sensible to panic at this stage, but we cannot add a panic without breaking backwards
// compatibility.
_ = hi.initialize()
}
func (hi *hmacImplementation) Size() int {
return hi.size
}
func (hi *hmacImplementation) BlockSize() int {
return hi.blockSize
}
|