1 /*- 2 * Copyright (c) 2009 The NetBSD Foundation, Inc. 3 * All rights reserved. 4 * 5 * This code is derived from software contributed to The NetBSD Foundation 6 * by Alistair Crooks (agc@NetBSD.org) 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 */ 29 /* 30 * Copyright (c) 2005-2008 Nominet UK (www.nic.uk) 31 * All rights reserved. 32 * Contributors: Ben Laurie, Rachel Willmer. The Contributors have asserted 33 * their moral rights under the UK Copyright Design and Patents Act 1988 to 34 * be recorded as the authors of this copyright work. 35 * 36 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 37 * use this file except in compliance with the License. 38 * 39 * You may obtain a copy of the License at 40 * http://www.apache.org/licenses/LICENSE-2.0 41 * 42 * Unless required by applicable law or agreed to in writing, software 43 * distributed under the License is distributed on an "AS IS" BASIS, 44 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 45 * 46 * See the License for the specific language governing permissions and 47 * limitations under the License. 48 */ 49 50 /** \file 51 * packet related headers. 52 */ 53 54 #ifndef PACKET_H_ 55 #define PACKET_H_ 56 57 #include <time.h> 58 59 #ifdef HAVE_OPENSSL_BN_H 60 #include <openssl/bn.h> 61 #endif 62 63 #include "types.h" 64 #include "errors.h" 65 66 /* structure to keep track of printing state variables */ 67 typedef struct __ops_printstate_t { 68 unsigned unarmoured; 69 unsigned skipping; 70 int indent; 71 } __ops_printstate_t; 72 73 /** General-use structure for variable-length data 74 */ 75 76 typedef struct { 77 size_t len; 78 uint8_t *contents; 79 uint8_t mmapped; /* contents need an munmap(2) */ 80 } __ops_data_t; 81 82 /************************************/ 83 /* Packet Tags - RFC4880, 4.2 */ 84 /************************************/ 85 86 /** Packet Tag - Bit 7 Mask (this bit is always set). 87 * The first byte of a packet is the "Packet Tag". It always 88 * has bit 7 set. This is the mask for it. 89 * 90 * \see RFC4880 4.2 91 */ 92 #define OPS_PTAG_ALWAYS_SET 0x80 93 94 /** Packet Tag - New Format Flag. 95 * Bit 6 of the Packet Tag is the packet format indicator. 96 * If it is set, the new format is used, if cleared the 97 * old format is used. 98 * 99 * \see RFC4880 4.2 100 */ 101 #define OPS_PTAG_NEW_FORMAT 0x40 102 103 104 /** Old Packet Format: Mask for content tag. 105 * In the old packet format bits 5 to 2 (including) 106 * are the content tag. This is the mask to apply 107 * to the packet tag. Note that you need to 108 * shift by #OPS_PTAG_OF_CONTENT_TAG_SHIFT bits. 109 * 110 * \see RFC4880 4.2 111 */ 112 #define OPS_PTAG_OF_CONTENT_TAG_MASK 0x3c 113 /** Old Packet Format: Offset for the content tag. 114 * As described at #OPS_PTAG_OF_CONTENT_TAG_MASK the 115 * content tag needs to be shifted after being masked 116 * out from the Packet Tag. 117 * 118 * \see RFC4880 4.2 119 */ 120 #define OPS_PTAG_OF_CONTENT_TAG_SHIFT 2 121 /** Old Packet Format: Mask for length type. 122 * Bits 1 and 0 of the packet tag are the length type 123 * in the old packet format. 124 * 125 * See #__ops_ptag_of_lt_t for the meaning of the values. 126 * 127 * \see RFC4880 4.2 128 */ 129 #define OPS_PTAG_OF_LENGTH_TYPE_MASK 0x03 130 131 132 /** Old Packet Format Lengths. 133 * Defines the meanings of the 2 bits for length type in the 134 * old packet format. 135 * 136 * \see RFC4880 4.2.1 137 */ 138 typedef enum { 139 OPS_PTAG_OLD_LEN_1 = 0x00, /* Packet has a 1 byte length - 140 * header is 2 bytes long. */ 141 OPS_PTAG_OLD_LEN_2 = 0x01, /* Packet has a 2 byte length - 142 * header is 3 bytes long. */ 143 OPS_PTAG_OLD_LEN_4 = 0x02, /* Packet has a 4 byte 144 * length - header is 5 bytes 145 * long. */ 146 OPS_PTAG_OLD_LEN_INDETERMINATE = 0x03 /* Packet has a 147 * indeterminate length. */ 148 } __ops_ptag_of_lt_t; 149 150 151 /** New Packet Format: Mask for content tag. 152 * In the new packet format the 6 rightmost bits 153 * are the content tag. This is the mask to apply 154 * to the packet tag. Note that you need to 155 * shift by #OPS_PTAG_NF_CONTENT_TAG_SHIFT bits. 156 * 157 * \see RFC4880 4.2 158 */ 159 #define OPS_PTAG_NF_CONTENT_TAG_MASK 0x3f 160 /** New Packet Format: Offset for the content tag. 161 * As described at #OPS_PTAG_NF_CONTENT_TAG_MASK the 162 * content tag needs to be shifted after being masked 163 * out from the Packet Tag. 164 * 165 * \see RFC4880 4.2 166 */ 167 #define OPS_PTAG_NF_CONTENT_TAG_SHIFT 0 168 169 /* PTag Content Tags */ 170 /***************************/ 171 172 /** Package Tags (aka Content Tags) and signature subpacket types. 173 * This enumerates all rfc-defined packet tag values and the 174 * signature subpacket type values that we understand. 175 * 176 * \see RFC4880 4.3 177 * \see RFC4880 5.2.3.1 178 */ 179 typedef enum { 180 OPS_PTAG_CT_RESERVED = 0, /* Reserved - a packet tag must 181 * not have this value */ 182 OPS_PTAG_CT_PK_SESSION_KEY = 1, /* Public-Key Encrypted Session 183 * Key Packet */ 184 OPS_PTAG_CT_SIGNATURE = 2, /* Signature Packet */ 185 OPS_PTAG_CT_SK_SESSION_KEY = 3, /* Symmetric-Key Encrypted Session 186 * Key Packet */ 187 OPS_PTAG_CT_1_PASS_SIG = 4, /* One-Pass Signature 188 * Packet */ 189 OPS_PTAG_CT_SECRET_KEY = 5, /* Secret Key Packet */ 190 OPS_PTAG_CT_PUBLIC_KEY = 6, /* Public Key Packet */ 191 OPS_PTAG_CT_SECRET_SUBKEY = 7, /* Secret Subkey Packet */ 192 OPS_PTAG_CT_COMPRESSED = 8, /* Compressed Data Packet */ 193 OPS_PTAG_CT_SE_DATA = 9,/* Symmetrically Encrypted Data Packet */ 194 OPS_PTAG_CT_MARKER = 10,/* Marker Packet */ 195 OPS_PTAG_CT_LITDATA = 11, /* Literal Data Packet */ 196 OPS_PTAG_CT_TRUST = 12, /* Trust Packet */ 197 OPS_PTAG_CT_USER_ID = 13, /* User ID Packet */ 198 OPS_PTAG_CT_PUBLIC_SUBKEY = 14, /* Public Subkey Packet */ 199 OPS_PTAG_CT_RESERVED2 = 15, /* reserved */ 200 OPS_PTAG_CT_RESERVED3 = 16, /* reserved */ 201 OPS_PTAG_CT_USER_ATTR = 17, /* User Attribute Packet */ 202 OPS_PTAG_CT_SE_IP_DATA = 18, /* Sym. Encrypted and Integrity 203 * Protected Data Packet */ 204 OPS_PTAG_CT_MDC = 19, /* Modification Detection Code Packet */ 205 206 OPS_PARSER_PTAG = 0x100,/* Internal Use: The packet is the "Packet 207 * Tag" itself - used when callback sends 208 * back the PTag. */ 209 OPS_PTAG_RAW_SS = 0x101,/* Internal Use: content is raw sig subtag */ 210 OPS_PTAG_SS_ALL = 0x102,/* Internal Use: select all subtags */ 211 OPS_PARSER_PACKET_END = 0x103, 212 213 /* signature subpackets (0x200-2ff) (type+0x200) */ 214 /* only those we can parse are listed here */ 215 OPS_PTAG_SIG_SUBPKT_BASE = 0x200, /* Base for signature 216 * subpacket types - All 217 * signature type values 218 * are relative to this 219 * value. */ 220 OPS_PTAG_SS_CREATION_TIME = 0x200 + 2, /* signature creation time */ 221 OPS_PTAG_SS_EXPIRATION_TIME = 0x200 + 3, /* signature 222 * expiration time */ 223 224 OPS_PTAG_SS_EXPORT_CERT = 0x200 + 4, /* exportable certification */ 225 OPS_PTAG_SS_TRUST = 0x200 + 5, /* trust signature */ 226 OPS_PTAG_SS_REGEXP = 0x200 + 6, /* regular expression */ 227 OPS_PTAG_SS_REVOCABLE = 0x200 + 7, /* revocable */ 228 OPS_PTAG_SS_KEY_EXPIRY = 0x200 + 9, /* key expiration 229 * time */ 230 OPS_PTAG_SS_RESERVED = 0x200 + 10, /* reserved */ 231 OPS_PTAG_SS_PREFERRED_SKA = 0x200 + 11, /* preferred symmetric 232 * algs */ 233 OPS_PTAG_SS_REVOCATION_KEY = 0x200 + 12, /* revocation key */ 234 OPS_PTAG_SS_ISSUER_KEY_ID = 0x200 + 16, /* issuer key ID */ 235 OPS_PTAG_SS_NOTATION_DATA = 0x200 + 20, /* notation data */ 236 OPS_PTAG_SS_PREFERRED_HASH = 0x200 + 21, /* preferred hash 237 * algs */ 238 OPS_PTAG_SS_PREF_COMPRESS = 0x200 + 22, /* preferred 239 * compression 240 * algorithms */ 241 OPS_PTAG_SS_KEYSERV_PREFS = 0x200 + 23, /* key server 242 * preferences */ 243 OPS_PTAG_SS_PREF_KEYSERV = 0x200 + 24, /* Preferred Key 244 * Server */ 245 OPS_PTAG_SS_PRIMARY_USER_ID = 0x200 + 25, /* primary User ID */ 246 OPS_PTAG_SS_POLICY_URI = 0x200 + 26, /* Policy URI */ 247 OPS_PTAG_SS_KEY_FLAGS = 0x200 + 27, /* key flags */ 248 OPS_PTAG_SS_SIGNERS_USER_ID = 0x200 + 28, /* Signer's User ID */ 249 OPS_PTAG_SS_REVOCATION_REASON = 0x200 + 29, /* reason for 250 * revocation */ 251 OPS_PTAG_SS_FEATURES = 0x200 + 30, /* features */ 252 OPS_PTAG_SS_SIGNATURE_TARGET = 0x200 + 31, /* signature target */ 253 OPS_PTAG_SS_EMBEDDED_SIGNATURE = 0x200 + 32, /* embedded signature */ 254 255 OPS_PTAG_SS_USERDEFINED00 = 0x200 + 100, /* internal or 256 * user-defined */ 257 OPS_PTAG_SS_USERDEFINED01 = 0x200 + 101, 258 OPS_PTAG_SS_USERDEFINED02 = 0x200 + 102, 259 OPS_PTAG_SS_USERDEFINED03 = 0x200 + 103, 260 OPS_PTAG_SS_USERDEFINED04 = 0x200 + 104, 261 OPS_PTAG_SS_USERDEFINED05 = 0x200 + 105, 262 OPS_PTAG_SS_USERDEFINED06 = 0x200 + 106, 263 OPS_PTAG_SS_USERDEFINED07 = 0x200 + 107, 264 OPS_PTAG_SS_USERDEFINED08 = 0x200 + 108, 265 OPS_PTAG_SS_USERDEFINED09 = 0x200 + 109, 266 OPS_PTAG_SS_USERDEFINED10 = 0x200 + 110, 267 268 /* pseudo content types */ 269 OPS_PTAG_CT_LITDATA_HEADER = 0x300, 270 OPS_PTAG_CT_LITDATA_BODY = 0x300 + 1, 271 OPS_PTAG_CT_SIGNATURE_HEADER = 0x300 + 2, 272 OPS_PTAG_CT_SIGNATURE_FOOTER = 0x300 + 3, 273 OPS_PTAG_CT_ARMOUR_HEADER = 0x300 + 4, 274 OPS_PTAG_CT_ARMOUR_TRAILER = 0x300 + 5, 275 OPS_PTAG_CT_SIGNED_CLEARTEXT_HEADER = 0x300 + 6, 276 OPS_PTAG_CT_SIGNED_CLEARTEXT_BODY = 0x300 + 7, 277 OPS_PTAG_CT_SIGNED_CLEARTEXT_TRAILER = 0x300 + 8, 278 OPS_PTAG_CT_UNARMOURED_TEXT = 0x300 + 9, 279 OPS_PTAG_CT_ENCRYPTED_SECRET_KEY = 0x300 + 10, /* In this case the 280 * algorithm specific 281 * fields will not be 282 * initialised */ 283 OPS_PTAG_CT_SE_DATA_HEADER = 0x300 + 11, 284 OPS_PTAG_CT_SE_DATA_BODY = 0x300 + 12, 285 OPS_PTAG_CT_SE_IP_DATA_HEADER = 0x300 + 13, 286 OPS_PTAG_CT_SE_IP_DATA_BODY = 0x300 + 14, 287 OPS_PTAG_CT_ENCRYPTED_PK_SESSION_KEY = 0x300 + 15, 288 289 /* commands to the callback */ 290 OPS_GET_PASSPHRASE = 0x400, 291 OPS_GET_SECKEY = 0x400 + 1, 292 293 /* Errors */ 294 OPS_PARSER_ERROR = 0x500, /* Internal Use: Parser Error */ 295 OPS_PARSER_ERRCODE = 0x500 + 1 /* Internal Use: Parser Error 296 * with errcode returned */ 297 } __ops_content_tag_t; 298 299 typedef __ops_content_tag_t __ops_packet_tag_t; 300 typedef __ops_content_tag_t __ops_ss_type_t; 301 302 /** Structure to hold one parse error string. */ 303 typedef struct { 304 const char *error; /* error message. */ 305 } __ops_parser_error_t; 306 307 /** Structure to hold one error code */ 308 typedef struct { 309 __ops_errcode_t errcode; 310 } __ops_parser_errcode_t; 311 312 /** Structure to hold one packet tag. 313 * \see RFC4880 4.2 314 */ 315 typedef struct { 316 unsigned new_format; /* Whether this packet tag is new 317 * (1) or old format (0) */ 318 unsigned type; /* content_tag value - See 319 * #__ops_content_tag_t for meanings */ 320 __ops_ptag_of_lt_t length_type; /* Length type (#__ops_ptag_of_lt_t) 321 * - only if this packet tag is old 322 * format. Set to 0 if new format. */ 323 unsigned length; /* The length of the packet. This value 324 * is set when we read and compute the length 325 * information, not at the same moment we 326 * create the packet tag structure. Only 327 * defined if #readc is set. *//* XXX: Ben, is this correct? */ 328 unsigned position; /* The position (within the 329 * current reader) of the packet */ 330 unsigned size; /* number of bits */ 331 } __ops_ptag_t; 332 333 /** Public Key Algorithm Numbers. 334 * OpenPGP assigns a unique Algorithm Number to each algorithm that is part of OpenPGP. 335 * 336 * This lists algorithm numbers for public key algorithms. 337 * 338 * \see RFC4880 9.1 339 */ 340 typedef enum { 341 OPS_PKA_NOTHING = 0, /* No PKA */ 342 OPS_PKA_RSA = 1, /* RSA (Encrypt or Sign) */ 343 OPS_PKA_RSA_ENCRYPT_ONLY = 2, /* RSA Encrypt-Only (deprecated - 344 * \see RFC4880 13.5) */ 345 OPS_PKA_RSA_SIGN_ONLY = 3, /* RSA Sign-Only (deprecated - 346 * \see RFC4880 13.5) */ 347 OPS_PKA_ELGAMAL = 16, /* Elgamal (Encrypt-Only) */ 348 OPS_PKA_DSA = 17, /* DSA (Digital Signature Algorithm) */ 349 OPS_PKA_RESERVED_ELLIPTIC_CURVE = 18, /* Reserved for Elliptic 350 * Curve */ 351 OPS_PKA_RESERVED_ECDSA = 19, /* Reserved for ECDSA */ 352 OPS_PKA_ELGAMAL_ENCRYPT_OR_SIGN = 20, /* Deprecated. */ 353 OPS_PKA_RESERVED_DH = 21, /* Reserved for Diffie-Hellman 354 * (X9.42, as defined for 355 * IETF-S/MIME) */ 356 OPS_PKA_PRIVATE00 = 100,/* Private/Experimental Algorithm */ 357 OPS_PKA_PRIVATE01 = 101,/* Private/Experimental Algorithm */ 358 OPS_PKA_PRIVATE02 = 102,/* Private/Experimental Algorithm */ 359 OPS_PKA_PRIVATE03 = 103,/* Private/Experimental Algorithm */ 360 OPS_PKA_PRIVATE04 = 104,/* Private/Experimental Algorithm */ 361 OPS_PKA_PRIVATE05 = 105,/* Private/Experimental Algorithm */ 362 OPS_PKA_PRIVATE06 = 106,/* Private/Experimental Algorithm */ 363 OPS_PKA_PRIVATE07 = 107,/* Private/Experimental Algorithm */ 364 OPS_PKA_PRIVATE08 = 108,/* Private/Experimental Algorithm */ 365 OPS_PKA_PRIVATE09 = 109,/* Private/Experimental Algorithm */ 366 OPS_PKA_PRIVATE10 = 110 /* Private/Experimental Algorithm */ 367 } __ops_pubkey_alg_t; 368 369 /** Structure to hold one DSA public key params. 370 * 371 * \see RFC4880 5.5.2 372 */ 373 typedef struct { 374 BIGNUM *p; /* DSA prime p */ 375 BIGNUM *q; /* DSA group order q */ 376 BIGNUM *g; /* DSA group generator g */ 377 BIGNUM *y; /* DSA public key value y (= g^x mod p 378 * with x being the secret) */ 379 } __ops_dsa_pubkey_t; 380 381 /** Structure to hold an RSA public key. 382 * 383 * \see RFC4880 5.5.2 384 */ 385 typedef struct { 386 BIGNUM *n; /* RSA public modulus n */ 387 BIGNUM *e; /* RSA public encryption exponent e */ 388 } __ops_rsa_pubkey_t; 389 390 /** Structure to hold an ElGamal public key params. 391 * 392 * \see RFC4880 5.5.2 393 */ 394 typedef struct { 395 BIGNUM *p; /* ElGamal prime p */ 396 BIGNUM *g; /* ElGamal group generator g */ 397 BIGNUM *y; /* ElGamal public key value y (= g^x mod p 398 * with x being the secret) */ 399 } __ops_elgamal_pubkey_t; 400 401 /** Union to hold public key params of any algorithm */ 402 typedef union { 403 __ops_dsa_pubkey_t dsa; /* A DSA public key */ 404 __ops_rsa_pubkey_t rsa; /* An RSA public key */ 405 __ops_elgamal_pubkey_t elgamal; /* An ElGamal public key */ 406 } __ops_pubkey_union_t; 407 408 /** Version. 409 * OpenPGP has two different protocol versions: version 3 and version 4. 410 * 411 * \see RFC4880 5.2 412 */ 413 typedef enum { 414 OPS_V2 = 2, /* Version 2 (essentially the same as v3) */ 415 OPS_V3 = 3, /* Version 3 */ 416 OPS_V4 = 4 /* Version 4 */ 417 } __ops_version_t; 418 419 /** Structure to hold a pgp public key */ 420 typedef struct { 421 __ops_version_t version;/* version of the key (v3, v4...) */ 422 time_t birthtime; 423 time_t duration; 424 /* validity period of the key in days since 425 * creation. A value of 0 has a special meaning 426 * indicating this key does not expire. Only used with 427 * v3 keys. */ 428 unsigned days_valid; /* v4 duration */ 429 __ops_pubkey_alg_t alg; /* Public Key Algorithm type */ 430 __ops_pubkey_union_t key; /* Public Key Parameters */ 431 } __ops_pubkey_t; 432 433 /** Structure to hold data for one RSA secret key 434 */ 435 typedef struct { 436 BIGNUM *d; 437 BIGNUM *p; 438 BIGNUM *q; 439 BIGNUM *u; 440 } __ops_rsa_seckey_t; 441 442 /** __ops_dsa_seckey_t */ 443 typedef struct { 444 BIGNUM *x; 445 } __ops_dsa_seckey_t; 446 447 /** __ops_seckey_union_t */ 448 typedef union { 449 __ops_rsa_seckey_t rsa; 450 __ops_dsa_seckey_t dsa; 451 } __ops_seckey_union_t; 452 453 /** s2k_usage_t 454 */ 455 typedef enum { 456 OPS_S2KU_NONE = 0, 457 OPS_S2KU_ENCRYPTED_AND_HASHED = 254, 458 OPS_S2KU_ENCRYPTED = 255 459 } __ops_s2k_usage_t; 460 461 /** s2k_specifier_t 462 */ 463 typedef enum { 464 OPS_S2KS_SIMPLE = 0, 465 OPS_S2KS_SALTED = 1, 466 OPS_S2KS_ITERATED_AND_SALTED = 3 467 } __ops_s2k_specifier_t; 468 469 /** Symmetric Key Algorithm Numbers. 470 * OpenPGP assigns a unique Algorithm Number to each algorithm that is 471 * part of OpenPGP. 472 * 473 * This lists algorithm numbers for symmetric key algorithms. 474 * 475 * \see RFC4880 9.2 476 */ 477 typedef enum { 478 OPS_SA_PLAINTEXT = 0, /* Plaintext or unencrypted data */ 479 OPS_SA_IDEA = 1, /* IDEA */ 480 OPS_SA_TRIPLEDES = 2, /* TripleDES */ 481 OPS_SA_CAST5 = 3, /* CAST5 */ 482 OPS_SA_BLOWFISH = 4, /* Blowfish */ 483 OPS_SA_AES_128 = 7, /* AES with 128-bit key (AES) */ 484 OPS_SA_AES_192 = 8, /* AES with 192-bit key */ 485 OPS_SA_AES_256 = 9, /* AES with 256-bit key */ 486 OPS_SA_TWOFISH = 10 /* Twofish with 256-bit key (TWOFISH) */ 487 } __ops_symm_alg_t; 488 489 /** Hashing Algorithm Numbers. 490 * OpenPGP assigns a unique Algorithm Number to each algorithm that is 491 * part of OpenPGP. 492 * 493 * This lists algorithm numbers for hash algorithms. 494 * 495 * \see RFC4880 9.4 496 */ 497 typedef enum { 498 OPS_HASH_UNKNOWN = -1, /* used to indicate errors */ 499 OPS_HASH_MD5 = 1, /* MD5 */ 500 OPS_HASH_SHA1 = 2, /* SHA-1 */ 501 OPS_HASH_RIPEMD = 3, /* RIPEMD160 */ 502 503 OPS_HASH_SHA256 = 8, /* SHA256 */ 504 OPS_HASH_SHA384 = 9, /* SHA384 */ 505 OPS_HASH_SHA512 = 10, /* SHA512 */ 506 OPS_HASH_SHA224 = 11 /* SHA224 */ 507 } __ops_hash_alg_t; 508 509 #define OPS_DEFAULT_HASH_ALGORITHM OPS_HASH_SHA256 510 511 void __ops_calc_mdc_hash(const uint8_t *, 512 const size_t, 513 const uint8_t *, 514 const unsigned, 515 uint8_t *); 516 unsigned __ops_is_hash_alg_supported(const __ops_hash_alg_t *); 517 518 /* Maximum block size for symmetric crypto */ 519 #define OPS_MAX_BLOCK_SIZE 16 520 521 /* Maximum key size for symmetric crypto */ 522 #define OPS_MAX_KEY_SIZE 32 523 524 /* Salt size for hashing */ 525 #define OPS_SALT_SIZE 8 526 527 /* Max hash size */ 528 #define OPS_MAX_HASH_SIZE 64 529 530 /** __ops_seckey_t 531 */ 532 typedef struct { 533 __ops_pubkey_t pubkey; 534 __ops_s2k_usage_t s2k_usage; 535 __ops_s2k_specifier_t s2k_specifier; 536 __ops_symm_alg_t alg; 537 __ops_hash_alg_t hash_alg; 538 uint8_t salt[OPS_SALT_SIZE]; 539 unsigned octetc; 540 uint8_t iv[OPS_MAX_BLOCK_SIZE]; 541 __ops_seckey_union_t key; 542 unsigned checksum; 543 uint8_t *checkhash; 544 } __ops_seckey_t; 545 546 /** Structure to hold one trust packet's data */ 547 548 typedef struct { 549 __ops_data_t data; /* Trust Packet */ 550 } __ops_trust_t; 551 552 /** Structure to hold one user id */ 553 typedef struct { 554 uint8_t *userid;/* User ID - UTF-8 string */ 555 } __ops_userid_t; 556 557 /** Structure to hold one user attribute */ 558 typedef struct { 559 __ops_data_t data; /* User Attribute */ 560 } __ops_userattr_t; 561 562 /** Signature Type. 563 * OpenPGP defines different signature types that allow giving 564 * different meanings to signatures. Signature types include 0x10 for 565 * generitc User ID certifications (used when Ben signs Weasel's key), 566 * Subkey binding signatures, document signatures, key revocations, 567 * etc. 568 * 569 * Different types are used in different places, and most make only 570 * sense in their intended location (for instance a subkey binding has 571 * no place on a UserID). 572 * 573 * \see RFC4880 5.2.1 574 */ 575 typedef enum { 576 OPS_SIG_BINARY = 0x00, /* Signature of a binary document */ 577 OPS_SIG_TEXT = 0x01, /* Signature of a canonical text document */ 578 OPS_SIG_STANDALONE = 0x02, /* Standalone signature */ 579 580 OPS_CERT_GENERIC = 0x10,/* Generic certification of a User ID and 581 * Public Key packet */ 582 OPS_CERT_PERSONA = 0x11,/* Persona certification of a User ID and 583 * Public Key packet */ 584 OPS_CERT_CASUAL = 0x12, /* Casual certification of a User ID and 585 * Public Key packet */ 586 OPS_CERT_POSITIVE = 0x13, /* Positive certification of a 587 * User ID and Public Key packet */ 588 589 OPS_SIG_SUBKEY = 0x18, /* Subkey Binding Signature */ 590 OPS_SIG_PRIMARY = 0x19, /* Primary Key Binding Signature */ 591 OPS_SIG_DIRECT = 0x1f, /* Signature directly on a key */ 592 593 OPS_SIG_REV_KEY = 0x20, /* Key revocation signature */ 594 OPS_SIG_REV_SUBKEY = 0x28, /* Subkey revocation signature */ 595 OPS_SIG_REV_CERT = 0x30,/* Certification revocation signature */ 596 597 OPS_SIG_TIMESTAMP = 0x40, /* Timestamp signature */ 598 599 OPS_SIG_3RD_PARTY = 0x50/* Third-Party Confirmation signature */ 600 } __ops_sig_type_t; 601 602 /** Struct to hold params of an RSA signature */ 603 typedef struct { 604 BIGNUM *sig; /* the signature value (m^d % n) */ 605 } __ops_rsa_sig_t; 606 607 /** Struct to hold params of a DSA signature */ 608 typedef struct { 609 BIGNUM *r; /* DSA value r */ 610 BIGNUM *s; /* DSA value s */ 611 } __ops_dsa_sig_t; 612 613 /** __ops_elgamal_signature_t */ 614 typedef struct { 615 BIGNUM *r; 616 BIGNUM *s; 617 } __ops_elgamal_sig_t; 618 619 /** Struct to hold data for a private/experimental signature */ 620 typedef struct { 621 __ops_data_t data; 622 } __ops_unknown_sig_t; 623 624 /** Union to hold signature params of any algorithm */ 625 typedef union { 626 __ops_rsa_sig_t rsa;/* An RSA Signature */ 627 __ops_dsa_sig_t dsa;/* A DSA Signature */ 628 __ops_elgamal_sig_t elgamal; /* deprecated */ 629 __ops_unknown_sig_t unknown; /* private or experimental */ 630 } __ops_sig_union_t; 631 632 #define OPS_KEY_ID_SIZE 8 633 #define OPS_FINGERPRINT_SIZE 20 634 635 /** Struct to hold a signature packet. 636 * 637 * \see RFC4880 5.2.2 638 * \see RFC4880 5.2.3 639 */ 640 typedef struct { 641 __ops_version_t version;/* signature version number */ 642 __ops_sig_type_t type; /* signature type value */ 643 time_t birthtime; /* creation time of the signature */ 644 time_t duration; /* number of seconds it's valid for */ 645 uint8_t signer_id[OPS_KEY_ID_SIZE]; /* Eight-octet key ID 646 * of signer */ 647 __ops_pubkey_alg_t key_alg; /* public key algorithm number */ 648 __ops_hash_alg_t hash_alg; /* hashing algorithm number */ 649 __ops_sig_union_t sig; /* signature params */ 650 size_t v4_hashlen; 651 uint8_t *v4_hashed; 652 unsigned birthtime_set:1; 653 unsigned signer_id_set:1; 654 unsigned duration_set:1; 655 } __ops_sig_info_t; 656 657 /** Struct used when parsing a signature */ 658 typedef struct __ops_sig_t { 659 __ops_sig_info_t info; /* The signature information */ 660 /* The following fields are only used while parsing the signature */ 661 uint8_t hash2[2]; /* high 2 bytes of hashed value */ 662 size_t v4_hashstart; /* only valid if accumulate is set */ 663 __ops_hash_t *hash; /* the hash filled in for the data so far */ 664 } __ops_sig_t; 665 666 /** The raw bytes of a signature subpacket */ 667 668 typedef struct { 669 __ops_content_tag_t tag; 670 size_t length; 671 uint8_t *raw; 672 } __ops_ss_raw_t; 673 674 /** Signature Subpacket : Trust Level */ 675 676 typedef struct { 677 uint8_t level; /* Trust Level */ 678 uint8_t amount; /* Amount */ 679 } __ops_ss_trust_t; 680 681 /** Signature Subpacket : Revocable */ 682 typedef struct { 683 unsigned revocable; 684 } __ops_ss_revocable_t; 685 686 /** Signature Subpacket : Time */ 687 typedef struct { 688 time_t time; 689 } __ops_ss_time_t; 690 691 /** Signature Subpacket : Key ID */ 692 typedef struct { 693 uint8_t key_id[OPS_KEY_ID_SIZE]; 694 } __ops_ss_key_id_t; 695 696 /** Signature Subpacket : Notation Data */ 697 typedef struct { 698 __ops_data_t flags; 699 __ops_data_t name; 700 __ops_data_t value; 701 } __ops_ss_notation_t; 702 703 /** Signature Subpacket : User Defined */ 704 typedef struct { 705 __ops_data_t data; 706 } __ops_ss_userdef_t; 707 708 /** Signature Subpacket : Unknown */ 709 typedef struct { 710 __ops_data_t data; 711 } __ops_ss_unknown_t; 712 713 /** Signature Subpacket : Preferred Symmetric Key Algorithm */ 714 typedef struct { 715 __ops_data_t data; 716 /* 717 * Note that value 0 may represent the plaintext algorithm so we 718 * cannot expect data->contents to be a null-terminated list 719 */ 720 } __ops_ss_skapref_t; 721 722 /** Signature Subpacket : Preferrred Hash Algorithm */ 723 typedef struct { 724 __ops_data_t data; 725 } __ops_ss_hashpref_t; 726 727 /** Signature Subpacket : Preferred Compression */ 728 typedef struct { 729 __ops_data_t data; 730 } __ops_ss_zpref_t; 731 732 /** Signature Subpacket : Key Flags */ 733 typedef struct { 734 __ops_data_t data; 735 } __ops_ss_key_flags_t; 736 737 /** Signature Subpacket : Key Server Preferences */ 738 typedef struct { 739 __ops_data_t data; 740 } __ops_ss_key_server_prefs_t; 741 742 /** Signature Subpacket : Features */ 743 typedef struct { 744 __ops_data_t data; 745 } __ops_ss_features_t; 746 747 /** Signature Subpacket : Signature Target */ 748 typedef struct { 749 __ops_pubkey_alg_t pka_alg; 750 __ops_hash_alg_t hash_alg; 751 __ops_data_t hash; 752 } __ops_ss_sig_target_t; 753 754 /** Signature Subpacket : Embedded Signature */ 755 typedef struct { 756 __ops_data_t sig; 757 } __ops_ss_embedded_sig_t; 758 759 /** __ops_subpacket_t */ 760 761 typedef struct __ops_subpacket_t { 762 size_t length; 763 uint8_t *raw; 764 } __ops_subpacket_t; 765 766 /** Types of Compression */ 767 typedef enum { 768 OPS_C_NONE = 0, 769 OPS_C_ZIP = 1, 770 OPS_C_ZLIB = 2, 771 OPS_C_BZIP2 = 3 772 } __ops_compression_type_t; 773 774 /* 775 * unlike most structures, this will feed its data as a stream to the 776 * application instead of directly including it 777 */ 778 /** __ops_compressed_t */ 779 typedef struct { 780 __ops_compression_type_t type; 781 } __ops_compressed_t; 782 783 /** __ops_one_pass_sig_t */ 784 typedef struct { 785 uint8_t version; 786 __ops_sig_type_t sig_type; 787 __ops_hash_alg_t hash_alg; 788 __ops_pubkey_alg_t key_alg; 789 uint8_t keyid[OPS_KEY_ID_SIZE]; 790 unsigned nested; 791 } __ops_one_pass_sig_t; 792 793 /** Signature Subpacket : Primary User ID */ 794 typedef struct { 795 unsigned primary_userid; 796 } __ops_ss_primary_userid_t; 797 798 /** Signature Subpacket : Regexp */ 799 typedef struct { 800 char *regexp; 801 } __ops_ss_regexp_t; 802 803 /** Signature Subpacket : Policy URL */ 804 typedef struct { 805 char *url; 806 } __ops_ss_policy_t; 807 808 /** Signature Subpacket : Preferred Key Server */ 809 typedef struct { 810 char *name; 811 } __ops_ss_keyserv_t; 812 813 /** Signature Subpacket : Revocation Key */ 814 typedef struct { 815 uint8_t class; 816 uint8_t algid; 817 uint8_t fingerprint[OPS_FINGERPRINT_SIZE]; 818 } __ops_ss_revocation_key_t; 819 820 /** Signature Subpacket : Revocation Reason */ 821 typedef struct { 822 uint8_t code; 823 char *reason; 824 } __ops_ss_revocation_t; 825 826 /** litdata_type_t */ 827 typedef enum { 828 OPS_LDT_BINARY = 'b', 829 OPS_LDT_TEXT = 't', 830 OPS_LDT_UTF8 = 'u', 831 OPS_LDT_LOCAL = 'l', 832 OPS_LDT_LOCAL2 = '1' 833 } __ops_litdata_type_t; 834 835 /** __ops_litdata_header_t */ 836 typedef struct { 837 __ops_litdata_type_t format; 838 char filename[256]; 839 time_t mtime; 840 } __ops_litdata_header_t; 841 842 /** __ops_litdata_body_t */ 843 typedef struct { 844 unsigned length; 845 uint8_t *data; 846 void *mem; /* __ops_memory_t pointer */ 847 } __ops_litdata_body_t; 848 849 /** __ops_mdc_t */ 850 typedef struct { 851 unsigned length; 852 uint8_t *data; 853 } __ops_mdc_t; 854 855 /** __ops_header_var_t */ 856 typedef struct { 857 char *key; 858 char *value; 859 } __ops_header_var_t; 860 861 /** __ops_headers_t */ 862 typedef struct { 863 __ops_header_var_t *headers; 864 unsigned headerc; 865 } __ops_headers_t; 866 867 /** __ops_armour_header_t */ 868 typedef struct { 869 const char *type; 870 __ops_headers_t headers; 871 } __ops_armour_header_t; 872 873 /** __ops_armour_trailer_t */ 874 typedef struct { 875 const char *type; 876 } __ops_armour_trailer_t; 877 878 /** __ops_cleartext_head_t */ 879 typedef struct { 880 __ops_headers_t headers; 881 } __ops_cleartext_head_t; 882 883 /** __ops_cleartext_body_t */ 884 typedef struct { 885 unsigned length; 886 uint8_t data[8192]; /* \todo fix hard-coded value? */ 887 } __ops_cleartext_body_t; 888 889 /** __ops_cleartext_trailer_t */ 890 typedef struct { 891 struct _ops_hash_t *hash; /* This will not have been 892 * finalised, but will have seen all 893 * the cleartext data in canonical 894 * form */ 895 } __ops_cleartext_trailer_t; 896 897 /** __ops_unarmoured_text_t */ 898 typedef struct { 899 unsigned length; 900 uint8_t *data; 901 } __ops_unarmoured_text_t; 902 903 typedef enum { 904 SE_IP_DATA_VERSION = 1 905 } __ops_se_ip_data_version_t; 906 907 typedef enum { 908 OPS_PKSK_V3 = 3 909 } __ops_pk_sesskey_version_t; 910 911 /** __ops_pk_sesskey_params_rsa_t */ 912 typedef struct { 913 BIGNUM *encrypted_m; 914 BIGNUM *m; 915 } __ops_pk_sesskey_params_rsa_t; 916 917 /** __ops_pk_sesskey_params_elgamal_t */ 918 typedef struct { 919 BIGNUM *g_to_k; 920 BIGNUM *encrypted_m; 921 } __ops_pk_sesskey_params_elgamal_t; 922 923 /** __ops_pk_sesskey_params_t */ 924 typedef union { 925 __ops_pk_sesskey_params_rsa_t rsa; 926 __ops_pk_sesskey_params_elgamal_t elgamal; 927 } __ops_pk_sesskey_params_t; 928 929 /** __ops_pk_sesskey_t */ 930 typedef struct { 931 __ops_pk_sesskey_version_t version; 932 uint8_t key_id[OPS_KEY_ID_SIZE]; 933 __ops_pubkey_alg_t alg; 934 __ops_pk_sesskey_params_t params; 935 __ops_symm_alg_t symm_alg; 936 uint8_t key[OPS_MAX_KEY_SIZE]; 937 uint16_t checksum; 938 } __ops_pk_sesskey_t; 939 940 /** __ops_seckey_passphrase_t */ 941 typedef struct { 942 const __ops_seckey_t *seckey; 943 char **passphrase; /* point somewhere that gets filled 944 * in to work around constness of 945 * content */ 946 } __ops_seckey_passphrase_t; 947 948 typedef enum { 949 OPS_SE_IP_V1 = 1 950 } __ops_se_ip_version_t; 951 952 /** __ops_se_ip_data_header_t */ 953 typedef struct { 954 __ops_se_ip_version_t version; 955 } __ops_se_ip_data_header_t; 956 957 /** __ops_se_ip_data_body_t */ 958 typedef struct { 959 unsigned length; 960 uint8_t *data; /* \todo remember to free this */ 961 } __ops_se_ip_data_body_t; 962 963 /** __ops_se_data_body_t */ 964 typedef struct { 965 unsigned length; 966 uint8_t data[8192]; /* \todo parameterise this! */ 967 } __ops_se_data_body_t; 968 969 /** __ops_get_seckey_t */ 970 typedef struct { 971 const __ops_seckey_t **seckey; 972 const __ops_pk_sesskey_t *pk_sesskey; 973 } __ops_get_seckey_t; 974 975 /** __ops_parser_union_content_t */ 976 typedef union { 977 __ops_parser_error_t error; 978 __ops_parser_errcode_t errcode; 979 __ops_ptag_t ptag; 980 __ops_pubkey_t pubkey; 981 __ops_trust_t trust; 982 __ops_userid_t userid; 983 __ops_userattr_t userattr; 984 __ops_sig_t sig; 985 __ops_ss_raw_t ss_raw; 986 __ops_ss_trust_t ss_trust; 987 __ops_ss_revocable_t ss_revocable; 988 __ops_ss_time_t ss_time; 989 __ops_ss_key_id_t ss_issuer; 990 __ops_ss_notation_t ss_notation; 991 __ops_subpacket_t packet; 992 __ops_compressed_t compressed; 993 __ops_one_pass_sig_t one_pass_sig; 994 __ops_ss_skapref_t ss_skapref; 995 __ops_ss_hashpref_t ss_hashpref; 996 __ops_ss_zpref_t ss_zpref; 997 __ops_ss_key_flags_t ss_key_flags; 998 __ops_ss_key_server_prefs_t ss_key_server_prefs; 999 __ops_ss_primary_userid_t ss_primary_userid; 1000 __ops_ss_regexp_t ss_regexp; 1001 __ops_ss_policy_t ss_policy; 1002 __ops_ss_keyserv_t ss_keyserv; 1003 __ops_ss_revocation_key_t ss_revocation_key; 1004 __ops_ss_userdef_t ss_userdef; 1005 __ops_ss_unknown_t ss_unknown; 1006 __ops_litdata_header_t litdata_header; 1007 __ops_litdata_body_t litdata_body; 1008 __ops_mdc_t mdc; 1009 __ops_ss_features_t ss_features; 1010 __ops_ss_sig_target_t ss_sig_target; 1011 __ops_ss_embedded_sig_t ss_embedded_sig; 1012 __ops_ss_revocation_t ss_revocation; 1013 __ops_seckey_t seckey; 1014 __ops_userid_t ss_signer; 1015 __ops_armour_header_t armour_header; 1016 __ops_armour_trailer_t armour_trailer; 1017 __ops_cleartext_head_t cleartext_head; 1018 __ops_cleartext_body_t cleartext_body; 1019 __ops_cleartext_trailer_t cleartext_trailer; 1020 __ops_unarmoured_text_t unarmoured_text; 1021 __ops_pk_sesskey_t pk_sesskey; 1022 __ops_seckey_passphrase_t skey_passphrase; 1023 __ops_se_ip_data_header_t se_ip_data_header; 1024 __ops_se_ip_data_body_t se_ip_data_body; 1025 __ops_se_data_body_t se_data_body; 1026 __ops_get_seckey_t get_seckey; 1027 } __ops_contents_t; 1028 1029 /** __ops_packet_t */ 1030 struct __ops_packet_t { 1031 __ops_content_tag_t tag; /* type of contents */ 1032 uint8_t critical; /* for sig subpackets */ 1033 __ops_contents_t u; /* union for contents */ 1034 }; 1035 1036 /** __ops_fingerprint_t */ 1037 typedef struct { 1038 uint8_t fingerprint[OPS_FINGERPRINT_SIZE]; 1039 unsigned length; 1040 } __ops_fingerprint_t; 1041 1042 void __ops_init(void); 1043 void __ops_finish(void); 1044 void __ops_keyid(uint8_t *, const size_t, const __ops_pubkey_t *); 1045 void __ops_fingerprint(__ops_fingerprint_t *, const __ops_pubkey_t *); 1046 void __ops_pubkey_free(__ops_pubkey_t *); 1047 void __ops_userid_free(__ops_userid_t *); 1048 void __ops_userattr_free(__ops_userattr_t *); 1049 void __ops_sig_free(__ops_sig_t *); 1050 void __ops_trust_free(__ops_trust_t *); 1051 void __ops_ss_skapref_free(__ops_ss_skapref_t *); 1052 void __ops_ss_hashpref_free(__ops_ss_hashpref_t *); 1053 void __ops_ss_zpref_free(__ops_ss_zpref_t *); 1054 void __ops_ss_key_flags_free(__ops_ss_key_flags_t *); 1055 void __ops_ss_key_server_prefs_free(__ops_ss_key_server_prefs_t *); 1056 void __ops_ss_features_free(__ops_ss_features_t *); 1057 void __ops_ss_notation_free(__ops_ss_notation_t *); 1058 void __ops_ss_policy_free(__ops_ss_policy_t *); 1059 void __ops_ss_keyserv_free(__ops_ss_keyserv_t *); 1060 void __ops_ss_regexp_free(__ops_ss_regexp_t *); 1061 void __ops_ss_userdef_free(__ops_ss_userdef_t *); 1062 void __ops_ss_reserved_free(__ops_ss_unknown_t *); 1063 void __ops_ss_revocation_free(__ops_ss_revocation_t *); 1064 void __ops_ss_sig_target_free(__ops_ss_sig_target_t *); 1065 void __ops_ss_embedded_sig_free(__ops_ss_embedded_sig_t *); 1066 1067 void __ops_subpacket_free(__ops_subpacket_t *); 1068 void __ops_parser_content_free(__ops_packet_t *); 1069 void __ops_seckey_free(__ops_seckey_t *); 1070 void __ops_pk_sesskey_free(__ops_pk_sesskey_t *); 1071 1072 int __ops_print_packet(__ops_printstate_t *, const __ops_packet_t *); 1073 1074 #define DYNARRAY(type, arr) \ 1075 unsigned arr##c; unsigned arr##vsize; type *arr##s 1076 1077 #define EXPAND_ARRAY(str, arr) do { \ 1078 if (str->arr##c == str->arr##vsize) { \ 1079 void *__newarr; \ 1080 str->arr##vsize = (str->arr##vsize * 2) + 10; \ 1081 if ((__newarr = realloc(str->arr##s, \ 1082 str->arr##vsize * sizeof(*str->arr##s))) == NULL) { \ 1083 (void) fprintf(stderr, "EXPAND_ARRAY - bad realloc\n"); \ 1084 } \ 1085 str->arr##s = __newarr; \ 1086 } \ 1087 } while(/*CONSTCOND*/0) 1088 1089 /** __ops_keydata_key_t 1090 */ 1091 typedef union { 1092 __ops_pubkey_t pubkey; 1093 __ops_seckey_t seckey; 1094 } __ops_keydata_key_t; 1095 1096 1097 /** sigpacket_t */ 1098 typedef struct { 1099 __ops_userid_t *userid; 1100 __ops_subpacket_t *packet; 1101 } sigpacket_t; 1102 1103 /* XXX: gonna have to expand this to hold onto subkeys, too... */ 1104 /** \struct __ops_keydata 1105 * \todo expand to hold onto subkeys 1106 */ 1107 struct __ops_key_t { 1108 DYNARRAY(__ops_userid_t, uid); 1109 DYNARRAY(__ops_subpacket_t, packet); 1110 DYNARRAY(sigpacket_t, sig); 1111 uint8_t key_id[OPS_KEY_ID_SIZE]; 1112 __ops_fingerprint_t fingerprint; 1113 __ops_content_tag_t type; 1114 __ops_keydata_key_t key; 1115 }; 1116 1117 #define MDC_PKT_TAG 0xd3 1118 1119 #endif /* PACKET_H_ */ 1120