1 /* $OpenBSD: cryptodev.h,v 1.68 2016/04/18 21:05:55 kettenis Exp $ */ 2 3 /* 4 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 5 * 6 * This code was written by Angelos D. Keromytis in Athens, Greece, in 7 * February 2000. Network Security Technologies Inc. (NSTI) kindly 8 * supported the development of this code. 9 * 10 * Copyright (c) 2000 Angelos D. Keromytis 11 * 12 * Permission to use, copy, and modify this software with or without fee 13 * is hereby granted, provided that this entire notice is included in 14 * all source code copies of any software which is or includes a copy or 15 * modification of this software. 16 * 17 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 18 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 19 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 20 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 21 * PURPOSE. 22 * 23 * Copyright (c) 2001 Theo de Raadt 24 * 25 * Redistribution and use in source and binary forms, with or without 26 * modification, are permitted provided that the following conditions 27 * are met: 28 * 29 * 1. Redistributions of source code must retain the above copyright 30 * notice, this list of conditions and the following disclaimer. 31 * 2. Redistributions in binary form must reproduce the above copyright 32 * notice, this list of conditions and the following disclaimer in the 33 * documentation and/or other materials provided with the distribution. 34 * 35 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 36 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 38 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 40 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 41 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 42 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 43 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 44 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 45 * 46 * Effort sponsored in part by the Defense Advanced Research Projects 47 * Agency (DARPA) and Air Force Research Laboratory, Air Force 48 * Materiel Command, USAF, under agreement number F30602-01-2-0537. 49 * 50 */ 51 52 #ifndef _CRYPTO_CRYPTO_H_ 53 #define _CRYPTO_CRYPTO_H_ 54 55 #include <sys/ioccom.h> 56 #include <sys/task.h> 57 58 /* Some initial values */ 59 #define CRYPTO_DRIVERS_INITIAL 4 60 #define CRYPTO_DRIVERS_MAX 128 61 #define CRYPTO_SW_SESSIONS 32 62 63 /* HMAC values */ 64 #define HMAC_MD5_BLOCK_LEN 64 65 #define HMAC_SHA1_BLOCK_LEN 64 66 #define HMAC_RIPEMD160_BLOCK_LEN 64 67 #define HMAC_SHA2_256_BLOCK_LEN 64 68 #define HMAC_SHA2_384_BLOCK_LEN 128 69 #define HMAC_SHA2_512_BLOCK_LEN 128 70 #define HMAC_MAX_BLOCK_LEN HMAC_SHA2_512_BLOCK_LEN /* keep in sync */ 71 #define HMAC_IPAD_VAL 0x36 72 #define HMAC_OPAD_VAL 0x5C 73 74 /* Encryption algorithm block sizes */ 75 #define DES3_BLOCK_LEN 8 76 #define BLOWFISH_BLOCK_LEN 8 77 #define CAST128_BLOCK_LEN 8 78 #define RIJNDAEL128_BLOCK_LEN 16 79 #define CHACHA20_BLOCK_LEN 64 80 #define EALG_MAX_BLOCK_LEN 64 /* Keep this updated */ 81 82 /* Maximum hash algorithm result length */ 83 #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 84 85 #define CRYPTO_3DES_CBC 1 86 #define CRYPTO_BLF_CBC 2 87 #define CRYPTO_CAST_CBC 3 88 #define CRYPTO_MD5_HMAC 4 89 #define CRYPTO_SHA1_HMAC 5 90 #define CRYPTO_RIPEMD160_HMAC 6 91 #define CRYPTO_RIJNDAEL128_CBC 7 /* 128 bit blocksize */ 92 #define CRYPTO_AES_CBC 7 /* 128 bit blocksize -- the same as above */ 93 #define CRYPTO_DEFLATE_COMP 8 /* Deflate compression algorithm */ 94 #define CRYPTO_NULL 9 95 #define CRYPTO_LZS_COMP 10 /* LZS compression algorithm */ 96 #define CRYPTO_SHA2_256_HMAC 11 97 #define CRYPTO_SHA2_384_HMAC 12 98 #define CRYPTO_SHA2_512_HMAC 13 99 #define CRYPTO_AES_CTR 14 100 #define CRYPTO_AES_XTS 15 101 #define CRYPTO_AES_GCM_16 16 102 #define CRYPTO_AES_128_GMAC 17 103 #define CRYPTO_AES_192_GMAC 18 104 #define CRYPTO_AES_256_GMAC 19 105 #define CRYPTO_AES_GMAC 20 106 #define CRYPTO_CHACHA20_POLY1305 21 107 #define CRYPTO_CHACHA20_POLY1305_MAC 22 108 #define CRYPTO_ESN 23 /* Support for Extended Sequence Numbers */ 109 #define CRYPTO_ALGORITHM_MAX 23 /* Keep updated */ 110 111 /* Algorithm flags */ 112 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 113 114 /* Standard initialization structure beginning */ 115 struct cryptoini { 116 int cri_alg; /* Algorithm to use */ 117 int cri_klen; /* Key length, in bits */ 118 int cri_rnd; /* Algorithm rounds, where relevant */ 119 caddr_t cri_key; /* key to use */ 120 union { 121 u_int8_t iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 122 u_int8_t esn[4]; /* high-order ESN */ 123 } u; 124 #define cri_iv u.iv 125 #define cri_esn u.esn 126 struct cryptoini *cri_next; 127 }; 128 129 /* Describe boundaries of a single crypto operation */ 130 struct cryptodesc { 131 int crd_skip; /* How many bytes to ignore from start */ 132 int crd_len; /* How many bytes to process */ 133 int crd_inject; /* Where to inject results, if applicable */ 134 int crd_flags; 135 136 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 137 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 138 place, so don't copy. */ 139 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 140 #define CRD_F_COMP 0x10 /* Set when doing compression */ 141 #define CRD_F_ESN 0x20 /* Set when ESN field is provided */ 142 143 struct cryptoini CRD_INI; /* Initialization/context data */ 144 #define crd_esn CRD_INI.cri_esn 145 #define crd_iv CRD_INI.cri_iv 146 #define crd_key CRD_INI.cri_key 147 #define crd_rnd CRD_INI.cri_rnd 148 #define crd_alg CRD_INI.cri_alg 149 #define crd_klen CRD_INI.cri_klen 150 151 struct cryptodesc *crd_next; 152 }; 153 154 /* Structure describing complete operation */ 155 struct cryptop { 156 struct task crp_task; 157 158 u_int64_t crp_sid; /* Session ID */ 159 int crp_ilen; /* Input data total length */ 160 int crp_olen; /* Result total length */ 161 int crp_alloctype; /* Type of buf to allocate if needed */ 162 163 int crp_etype; /* 164 * Error type (zero means no error). 165 * All error codes except EAGAIN 166 * indicate possible data corruption (as in, 167 * the data have been touched). On all 168 * errors, the crp_sid may have changed 169 * (reset to a new one), so the caller 170 * should always check and use the new 171 * value on future requests. 172 */ 173 int crp_flags; 174 175 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains, otherwise contig */ 176 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 177 #define CRYPTO_F_NOQUEUE 0x0008 /* Don't use crypto queue/thread */ 178 #define CRYPTO_F_DONE 0x0010 /* request completed */ 179 180 void *crp_buf; /* Data to be processed */ 181 void *crp_opaque; /* Opaque pointer, passed along */ 182 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 183 184 int (*crp_callback)(struct cryptop *); /* Callback function */ 185 186 caddr_t crp_mac; 187 }; 188 189 #define CRYPTO_BUF_IOV 0x1 190 #define CRYPTO_BUF_MBUF 0x2 191 192 #define CRYPTO_OP_DECRYPT 0x0 193 #define CRYPTO_OP_ENCRYPT 0x1 194 195 /* Crypto capabilities structure */ 196 struct cryptocap { 197 u_int64_t cc_operations; /* Counter of how many ops done */ 198 u_int64_t cc_bytes; /* Counter of how many bytes done */ 199 u_int64_t cc_koperations; /* How many PK ops done */ 200 201 u_int32_t cc_sessions; /* How many sessions allocated */ 202 203 /* Symmetric/hash algorithms supported */ 204 int cc_alg[CRYPTO_ALGORITHM_MAX + 1]; 205 206 int cc_queued; /* Operations queued */ 207 208 u_int8_t cc_flags; 209 #define CRYPTOCAP_F_CLEANUP 0x01 210 #define CRYPTOCAP_F_SOFTWARE 0x02 211 #define CRYPTOCAP_F_MPSAFE 0x04 212 213 int (*cc_newsession) (u_int32_t *, struct cryptoini *); 214 int (*cc_process) (struct cryptop *); 215 int (*cc_freesession) (u_int64_t); 216 }; 217 218 /* 219 * ioctl parameter to request creation of a session. 220 */ 221 struct session_op { 222 u_int32_t cipher; /* ie. CRYPTO_AES_CBC */ 223 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 224 225 u_int32_t keylen; /* cipher key */ 226 caddr_t key; 227 int mackeylen; /* mac key */ 228 caddr_t mackey; 229 230 u_int32_t ses; /* returns: session # */ 231 }; 232 233 /* 234 * ioctl parameter to request a crypt/decrypt operation against a session. 235 */ 236 struct crypt_op { 237 u_int32_t ses; 238 u_int16_t op; /* ie. COP_ENCRYPT */ 239 #define COP_ENCRYPT 1 240 #define COP_DECRYPT 2 241 u_int16_t flags; /* always 0 */ 242 243 u_int len; 244 caddr_t src, dst; /* become iov[] inside kernel */ 245 caddr_t mac; /* must be big enough for chosen MAC */ 246 caddr_t iv; 247 }; 248 249 #define CRYPTO_MAX_MAC_LEN 20 250 251 #ifdef _KERNEL 252 int crypto_newsession(u_int64_t *, struct cryptoini *, int); 253 int crypto_freesession(u_int64_t); 254 int crypto_dispatch(struct cryptop *); 255 int crypto_register(u_int32_t, int *, 256 int (*)(u_int32_t *, struct cryptoini *), int (*)(u_int64_t), 257 int (*)(struct cryptop *)); 258 int crypto_unregister(u_int32_t, int); 259 int32_t crypto_get_driverid(u_int8_t); 260 int crypto_invoke(struct cryptop *); 261 void crypto_done(struct cryptop *); 262 263 void cuio_copydata(struct uio *, int, int, caddr_t); 264 void cuio_copyback(struct uio *, int, int, const void *); 265 int cuio_getptr(struct uio *, int, int *); 266 int cuio_apply(struct uio *, int, int, 267 int (*f)(caddr_t, caddr_t, unsigned int), caddr_t); 268 269 struct cryptop *crypto_getreq(int); 270 void crypto_freereq(struct cryptop *); 271 #endif /* _KERNEL */ 272 #endif /* _CRYPTO_CRYPTO_H_ */ 273