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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
/*
* Copyright 2015-2018 Yubico AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef YUBIHSM_PKCS11_H
#define YUBIHSM_PKCS11_H
#include "pkcs11y.h"
#include "list.h"
#include <openssl/evp.h>
#include "../common/platform-config.h"
#include "../lib/internal.h"
#ifndef _MSVC
#include <sys/time.h>
#endif
#include <time.h>
#define YUBIHSM_PKCS11_OP_BUFSIZE 4096
#define MAX_ECDH_SESSION_KEYS 255
#define ECDH_KEY_BUF_SIZE 128
#define ECDH_KEY_TYPE 0x00FF
#ifndef AES_BLOCK_SIZE
#define AES_BLOCK_SIZE 16
#endif
#define CKA_ATTRIBUTE_VALUE_SIZE 256
typedef enum {
SESSION_RESERVED_RO = 1 << 0,
SESSION_RESERVED_RW = 1 << 1,
SESSION_AUTHENTICATED_RO = 1 << 2,
SESSION_AUTHENTICATED_RW = 1 << 3,
} yubihsm_pkcs11_session_state;
#define SESSION_AUTHENTICATED \
(SESSION_AUTHENTICATED_RO | SESSION_AUTHENTICATED_RW)
#define SESSION_NOT_AUTHENTICATED (SESSION_RESERVED_RO | SESSION_RESERVED_RW)
typedef struct {
uint16_t len;
uint8_t value[CKA_ATTRIBUTE_VALUE_SIZE];
} cka_meta_item;
typedef struct {
/// Original objectID of the asymmetric key/certificate/symmetric key
uint16_t target_id;
/// Original object type
yh_object_type target_type;
/// Original object sequence
uint8_t target_sequence;
/// CKA_ID for private key
cka_meta_item cka_id;
/// CKA_LABEL for private key
cka_meta_item cka_label;
/// CKA_ID for public key
cka_meta_item cka_id_pubkey;
/// CKA_LABEL for public key
cka_meta_item cka_label_pubkey;
} pkcs11_meta_object;
typedef struct {
struct timeval tv;
yh_object_descriptor object;
pkcs11_meta_object meta_object;
} yubihsm_pkcs11_object_desc;
typedef enum {
OPERATION_NOOP,
OPERATION_FIND,
OPERATION_GEN,
OPERATION_SIGN,
OPERATION_DIGEST,
OPERATION_DECRYPT,
OPERATION_VERIFY,
OPERATION_ENCRYPT
} yubihsm_pkcs11_op_type;
typedef enum {
PART_INIT,
PART_SINGLE,
PART_MULTIPLE,
} yubihsm_pkcs11_part_type;
typedef struct {
yh_object_descriptor objects[YH_MAX_ITEMS_COUNT];
size_t current_object;
size_t n_objects;
bool only_private;
} find_info;
typedef struct {
EVP_MD_CTX *md_ctx; // Digest context
uint16_t key_id; // Key id
CK_ULONG key_len; // Length in bits
uint16_t sig_len; // Length in bytes
} sign_info;
typedef struct {
EVP_MD_CTX *md_ctx; // Digest context
CK_ULONG digest_len; // Length in bits
} digest_info;
typedef struct {
uint16_t key_id; // Key id
CK_ULONG key_len; // Length in bits
bool finalized;
} decrypt_info;
typedef struct {
uint16_t key_id;
CK_ULONG key_len; // Length in bits
CK_ULONG padding; // RSA padding, 0 for EC
const EVP_MD *oaep_md;
const EVP_MD *mgf1_md;
unsigned char *oaep_label;
CK_ULONG oaep_label_len;
} encrypt_info;
typedef struct {
EVP_MD_CTX *md_ctx; // running hash
const EVP_MD *md; // digest used
int padding; // padding in the rsa case
unsigned long saltLen; // saltlen for rsa-pss
const EVP_MD *mgf1md; // mgf1 md used for rsa-pss
uint16_t key_id; // Key id
CK_ULONG key_len; // Length in bits
} verify_info;
typedef union {
find_info find;
sign_info sign;
digest_info digest;
verify_info verify;
decrypt_info decrypt;
encrypt_info encrypt;
} op;
typedef struct {
CK_MECHANISM_TYPE mechanism;
union {
struct {
uint8_t label[64]; // hash of OAEP label
unsigned int label_len; // length of the hashed label
yh_algorithm mgf1Algo;
} oaep;
struct {
uint16_t salt_len;
yh_algorithm mgf1Algo;
} pss;
struct {
uint8_t iv[AES_BLOCK_SIZE];
uint8_t orig[AES_BLOCK_SIZE];
} cbc;
};
} mechanism;
typedef struct {
// The session key ID 0x00 ff 0001, 0x00 ff 0002, 0x00 ff 0003...etc
CK_OBJECT_HANDLE id;
/// The key itself
uint8_t ecdh_key[ECDH_KEY_BUF_SIZE];
/// The length of the key
size_t len;
/// Object label
char label[YH_OBJ_LABEL_LEN + 1];
} ecdh_session_key;
typedef struct {
yubihsm_pkcs11_op_type type;
yubihsm_pkcs11_part_type part;
mechanism mechanism;
op op;
uint8_t buffer[YUBIHSM_PKCS11_OP_BUFSIZE];
unsigned int buffer_length;
} yubihsm_pkcs11_op_info;
typedef struct {
List slots;
List device_pubkeys;
CK_CREATEMUTEX create_mutex;
CK_DESTROYMUTEX destroy_mutex;
CK_LOCKMUTEX lock_mutex;
CK_UNLOCKMUTEX unlock_mutex;
void *mutex;
} yubihsm_pkcs11_context;
typedef struct {
uint16_t id;
uint16_t authkey_domains;
uint16_t max_session_id;
char *connector_name;
yh_connector *connector;
yh_session *device_session;
List pkcs11_sessions;
yubihsm_pkcs11_object_desc objects[YH_MAX_ITEMS_COUNT];
void *mutex;
} yubihsm_pkcs11_slot;
typedef struct {
uint16_t id;
yubihsm_pkcs11_op_info operation;
yubihsm_pkcs11_session_state session_state;
yubihsm_pkcs11_slot *slot;
List ecdh_session_keys;
} yubihsm_pkcs11_session;
typedef enum {
ATTRIBUTE_NOT_SET = 0,
ATTRIBUTE_FALSE,
ATTRIBUTE_TRUE,
} yubihsm_pkcs11_attribute;
typedef struct {
yh_algorithm algorithm;
uint16_t id;
char label[YH_OBJ_LABEL_LEN + 1];
yubihsm_pkcs11_attribute sign;
yubihsm_pkcs11_attribute encrypt;
yubihsm_pkcs11_attribute decrypt;
yubihsm_pkcs11_attribute derive;
yubihsm_pkcs11_attribute exportable;
yubihsm_pkcs11_attribute verify;
yubihsm_pkcs11_attribute wrap;
yubihsm_pkcs11_attribute unwrap;
uint16_t objlen;
union {
struct {
BIGNUM *p;
BIGNUM *q;
} rsa;
struct {
BIGNUM *d;
} ec;
uint8_t *buf;
} obj;
} yubihsm_pkcs11_object_template;
#ifdef _MSC_VER
#pragma strict_gs_check(on)
#endif
#endif
|