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 unsigned char *contents; 79 unsigned char 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 /* when the key was created. Note that 424 * interpretation varies with key version. */ 425 unsigned days_valid; 426 /* validity period of the key in days since 427 * creation. A value of 0 has a special meaning 428 * indicating this key does not expire. Only used with 429 * v3 keys. */ 430 __ops_pubkey_alg_t alg; /* Public Key Algorithm type */ 431 __ops_pubkey_union_t key; /* Public Key Parameters */ 432 } __ops_pubkey_t; 433 434 /** Structure to hold data for one RSA secret key 435 */ 436 typedef struct { 437 BIGNUM *d; 438 BIGNUM *p; 439 BIGNUM *q; 440 BIGNUM *u; 441 } __ops_rsa_seckey_t; 442 443 /** __ops_dsa_seckey_t */ 444 typedef struct { 445 BIGNUM *x; 446 } __ops_dsa_seckey_t; 447 448 /** __ops_seckey_union_t */ 449 typedef union { 450 __ops_rsa_seckey_t rsa; 451 __ops_dsa_seckey_t dsa; 452 } __ops_seckey_union_t; 453 454 /** s2k_usage_t 455 */ 456 typedef enum { 457 OPS_S2KU_NONE = 0, 458 OPS_S2KU_ENCRYPTED_AND_HASHED = 254, 459 OPS_S2KU_ENCRYPTED = 255 460 } __ops_s2k_usage_t; 461 462 /** s2k_specifier_t 463 */ 464 typedef enum { 465 OPS_S2KS_SIMPLE = 0, 466 OPS_S2KS_SALTED = 1, 467 OPS_S2KS_ITERATED_AND_SALTED = 3 468 } __ops_s2k_specifier_t; 469 470 /** Symmetric Key Algorithm Numbers. 471 * OpenPGP assigns a unique Algorithm Number to each algorithm that is 472 * part of OpenPGP. 473 * 474 * This lists algorithm numbers for symmetric key algorithms. 475 * 476 * \see RFC4880 9.2 477 */ 478 typedef enum { 479 OPS_SA_PLAINTEXT = 0, /* Plaintext or unencrypted data */ 480 OPS_SA_IDEA = 1, /* IDEA */ 481 OPS_SA_TRIPLEDES = 2, /* TripleDES */ 482 OPS_SA_CAST5 = 3, /* CAST5 */ 483 OPS_SA_BLOWFISH = 4, /* Blowfish */ 484 OPS_SA_AES_128 = 7, /* AES with 128-bit key (AES) */ 485 OPS_SA_AES_192 = 8, /* AES with 192-bit key */ 486 OPS_SA_AES_256 = 9, /* AES with 256-bit key */ 487 OPS_SA_TWOFISH = 10 /* Twofish with 256-bit key (TWOFISH) */ 488 } __ops_symm_alg_t; 489 490 /** Hashing Algorithm Numbers. 491 * OpenPGP assigns a unique Algorithm Number to each algorithm that is 492 * part of OpenPGP. 493 * 494 * This lists algorithm numbers for hash algorithms. 495 * 496 * \see RFC4880 9.4 497 */ 498 typedef enum { 499 OPS_HASH_UNKNOWN = -1, /* used to indicate errors */ 500 OPS_HASH_MD5 = 1, /* MD5 */ 501 OPS_HASH_SHA1 = 2, /* SHA-1 */ 502 OPS_HASH_RIPEMD = 3, /* RIPEMD160 */ 503 504 OPS_HASH_SHA256 = 8, /* SHA256 */ 505 OPS_HASH_SHA384 = 9, /* SHA384 */ 506 OPS_HASH_SHA512 = 10, /* SHA512 */ 507 OPS_HASH_SHA224 = 11 /* SHA224 */ 508 } __ops_hash_alg_t; 509 510 void __ops_calc_mdc_hash(const unsigned char *, 511 const size_t, 512 const unsigned char *, 513 const unsigned int, 514 unsigned char *); 515 unsigned __ops_is_hash_alg_supported(const __ops_hash_alg_t *); 516 517 /* Maximum block size for symmetric crypto */ 518 #define OPS_MAX_BLOCK_SIZE 16 519 520 /* Maximum key size for symmetric crypto */ 521 #define OPS_MAX_KEY_SIZE 32 522 523 /* Salt size for hashing */ 524 #define OPS_SALT_SIZE 8 525 526 /* Max hash size */ 527 #define OPS_MAX_HASH_SIZE 64 528 529 /** __ops_seckey_t 530 */ 531 typedef struct { 532 __ops_pubkey_t pubkey; 533 __ops_s2k_usage_t s2k_usage; 534 __ops_s2k_specifier_t s2k_specifier; 535 __ops_symm_alg_t alg; 536 __ops_hash_alg_t hash_alg; 537 unsigned char salt[OPS_SALT_SIZE]; 538 unsigned octetc; 539 unsigned char iv[OPS_MAX_BLOCK_SIZE]; 540 __ops_seckey_union_t key; 541 unsigned checksum; 542 unsigned char *checkhash; 543 } __ops_seckey_t; 544 545 /** Structure to hold one trust packet's data */ 546 547 typedef struct { 548 __ops_data_t data; /* Trust Packet */ 549 } __ops_trust_t; 550 551 /** Structure to hold one user id */ 552 typedef struct { 553 unsigned char *userid;/* User ID - UTF-8 string */ 554 } __ops_userid_t; 555 556 /** Structure to hold one user attribute */ 557 typedef struct { 558 __ops_data_t data; /* User Attribute */ 559 } __ops_userattr_t; 560 561 /** Signature Type. 562 * OpenPGP defines different signature types that allow giving 563 * different meanings to signatures. Signature types include 0x10 for 564 * generitc User ID certifications (used when Ben signs Weasel's key), 565 * Subkey binding signatures, document signatures, key revocations, 566 * etc. 567 * 568 * Different types are used in different places, and most make only 569 * sense in their intended location (for instance a subkey binding has 570 * no place on a UserID). 571 * 572 * \see RFC4880 5.2.1 573 */ 574 typedef enum { 575 OPS_SIG_BINARY = 0x00, /* Signature of a binary document */ 576 OPS_SIG_TEXT = 0x01, /* Signature of a canonical text document */ 577 OPS_SIG_STANDALONE = 0x02, /* Standalone signature */ 578 579 OPS_CERT_GENERIC = 0x10,/* Generic certification of a User ID and 580 * Public Key packet */ 581 OPS_CERT_PERSONA = 0x11,/* Persona certification of a User ID and 582 * Public Key packet */ 583 OPS_CERT_CASUAL = 0x12, /* Casual certification of a User ID and 584 * Public Key packet */ 585 OPS_CERT_POSITIVE = 0x13, /* Positive certification of a 586 * User ID and Public Key packet */ 587 588 OPS_SIG_SUBKEY = 0x18, /* Subkey Binding Signature */ 589 OPS_SIG_PRIMARY = 0x19, /* Primary Key Binding Signature */ 590 OPS_SIG_DIRECT = 0x1f, /* Signature directly on a key */ 591 592 OPS_SIG_REV_KEY = 0x20, /* Key revocation signature */ 593 OPS_SIG_REV_SUBKEY = 0x28, /* Subkey revocation signature */ 594 OPS_SIG_REV_CERT = 0x30,/* Certification revocation signature */ 595 596 OPS_SIG_TIMESTAMP = 0x40, /* Timestamp signature */ 597 598 OPS_SIG_3RD_PARTY = 0x50/* Third-Party Confirmation signature */ 599 } __ops_sig_type_t; 600 601 /** Struct to hold params of an RSA signature */ 602 typedef struct { 603 BIGNUM *sig; /* the signature value (m^d % n) */ 604 } __ops_rsa_sig_t; 605 606 /** Struct to hold params of a DSA signature */ 607 typedef struct { 608 BIGNUM *r; /* DSA value r */ 609 BIGNUM *s; /* DSA value s */ 610 } __ops_dsa_sig_t; 611 612 /** __ops_elgamal_signature_t */ 613 typedef struct { 614 BIGNUM *r; 615 BIGNUM *s; 616 } __ops_elgamal_sig_t; 617 618 /** Struct to hold data for a private/experimental signature */ 619 typedef struct { 620 __ops_data_t data; 621 } __ops_unknown_sig_t; 622 623 /** Union to hold signature params of any algorithm */ 624 typedef union { 625 __ops_rsa_sig_t rsa;/* An RSA Signature */ 626 __ops_dsa_sig_t dsa;/* A DSA Signature */ 627 __ops_elgamal_sig_t elgamal; /* deprecated */ 628 __ops_unknown_sig_t unknown; /* private or experimental */ 629 } __ops_sig_union_t; 630 631 #define OPS_KEY_ID_SIZE 8 632 #define OPS_FINGERPRINT_SIZE 20 633 634 /** Struct to hold a signature packet. 635 * 636 * \see RFC4880 5.2.2 637 * \see RFC4880 5.2.3 638 */ 639 typedef struct { 640 __ops_version_t version;/* signature version number */ 641 __ops_sig_type_t type; /* signature type value */ 642 time_t birthtime; /* creation time of the signature */ 643 time_t duration; /* number of seconds it's valid for */ 644 unsigned char signer_id[OPS_KEY_ID_SIZE]; /* Eight-octet key ID 645 * of signer */ 646 __ops_pubkey_alg_t key_alg; /* public key algorithm number */ 647 __ops_hash_alg_t hash_alg; /* hashing algorithm number */ 648 __ops_sig_union_t sig; /* signature params */ 649 size_t v4_hashlen; 650 unsigned char *v4_hashed; 651 unsigned birthtime_set:1; 652 unsigned signer_id_set:1; 653 unsigned duration_set:1; 654 } __ops_sig_info_t; 655 656 /** Struct used when parsing a signature */ 657 typedef struct __ops_sig_t { 658 __ops_sig_info_t info; /* The signature information */ 659 /* The following fields are only used while parsing the signature */ 660 unsigned char hash2[2]; /* high 2 bytes of hashed value - 661 * for quick test */ 662 size_t v4_hashstart; /* only valid if accumulate 663 * is set */ 664 __ops_hash_t *hash; /* if set, the hash filled in for the data 665 * so far */ 666 } __ops_sig_t; 667 668 /** The raw bytes of a signature subpacket */ 669 670 typedef struct { 671 __ops_content_tag_t tag; 672 size_t length; 673 unsigned char *raw; 674 } __ops_ss_raw_t; 675 676 /** Signature Subpacket : Trust Level */ 677 678 typedef struct { 679 unsigned char level; /* Trust Level */ 680 unsigned char amount; /* Amount */ 681 } __ops_ss_trust_t; 682 683 /** Signature Subpacket : Revocable */ 684 typedef struct { 685 unsigned revocable; 686 } __ops_ss_revocable_t; 687 688 /** Signature Subpacket : Time */ 689 typedef struct { 690 time_t time; 691 } __ops_ss_time_t; 692 693 /** Signature Subpacket : Key ID */ 694 typedef struct { 695 unsigned char key_id[OPS_KEY_ID_SIZE]; 696 } __ops_ss_key_id_t; 697 698 /** Signature Subpacket : Notation Data */ 699 typedef struct { 700 __ops_data_t flags; 701 __ops_data_t name; 702 __ops_data_t value; 703 } __ops_ss_notation_t; 704 705 /** Signature Subpacket : User Defined */ 706 typedef struct { 707 __ops_data_t data; 708 } __ops_ss_userdef_t; 709 710 /** Signature Subpacket : Unknown */ 711 typedef struct { 712 __ops_data_t data; 713 } __ops_ss_unknown_t; 714 715 /** Signature Subpacket : Preferred Symmetric Key Algorithm */ 716 typedef struct { 717 __ops_data_t data; 718 /* 719 * Note that value 0 may represent the plaintext algorithm so we 720 * cannot expect data->contents to be a null-terminated list 721 */ 722 } __ops_ss_skapref_t; 723 724 /** Signature Subpacket : Preferrred Hash Algorithm */ 725 typedef struct { 726 __ops_data_t data; 727 } __ops_ss_hashpref_t; 728 729 /** Signature Subpacket : Preferred Compression */ 730 typedef struct { 731 __ops_data_t data; 732 } __ops_ss_zpref_t; 733 734 /** Signature Subpacket : Key Flags */ 735 typedef struct { 736 __ops_data_t data; 737 } __ops_ss_key_flags_t; 738 739 /** Signature Subpacket : Key Server Preferences */ 740 typedef struct { 741 __ops_data_t data; 742 } __ops_ss_key_server_prefs_t; 743 744 /** Signature Subpacket : Features */ 745 typedef struct { 746 __ops_data_t data; 747 } __ops_ss_features_t; 748 749 /** Signature Subpacket : Signature Target */ 750 typedef struct { 751 __ops_pubkey_alg_t pka_alg; 752 __ops_hash_alg_t hash_alg; 753 __ops_data_t hash; 754 } __ops_ss_sig_target_t; 755 756 /** Signature Subpacket : Embedded Signature */ 757 typedef struct { 758 __ops_data_t sig; 759 } __ops_ss_embedded_sig_t; 760 761 /** __ops_subpacket_t */ 762 763 typedef struct __ops_subpacket_t { 764 size_t length; 765 unsigned char *raw; 766 } __ops_subpacket_t; 767 768 /** Types of Compression */ 769 typedef enum { 770 OPS_C_NONE = 0, 771 OPS_C_ZIP = 1, 772 OPS_C_ZLIB = 2, 773 OPS_C_BZIP2 = 3 774 } __ops_compression_type_t; 775 776 /* 777 * unlike most structures, this will feed its data as a stream to the 778 * application instead of directly including it 779 */ 780 /** __ops_compressed_t */ 781 typedef struct { 782 __ops_compression_type_t type; 783 } __ops_compressed_t; 784 785 /** __ops_one_pass_sig_t */ 786 typedef struct { 787 unsigned char version; 788 __ops_sig_type_t sig_type; 789 __ops_hash_alg_t hash_alg; 790 __ops_pubkey_alg_t key_alg; 791 unsigned char keyid[OPS_KEY_ID_SIZE]; 792 unsigned nested; 793 } __ops_one_pass_sig_t; 794 795 /** Signature Subpacket : Primary User ID */ 796 typedef struct { 797 unsigned primary_userid; 798 } __ops_ss_primary_userid_t; 799 800 /** Signature Subpacket : Regexp */ 801 typedef struct { 802 char *regexp; 803 } __ops_ss_regexp_t; 804 805 /** Signature Subpacket : Policy URL */ 806 typedef struct { 807 char *url; 808 } __ops_ss_policy_t; 809 810 /** Signature Subpacket : Preferred Key Server */ 811 typedef struct { 812 char *name; 813 } __ops_ss_keyserv_t; 814 815 /** Signature Subpacket : Revocation Key */ 816 typedef struct { 817 unsigned char class; 818 unsigned char algid; 819 unsigned char fingerprint[OPS_FINGERPRINT_SIZE]; 820 } __ops_ss_revocation_key_t; 821 822 /** Signature Subpacket : Revocation Reason */ 823 typedef struct { 824 unsigned char code; 825 char *reason; 826 } __ops_ss_revocation_t; 827 828 /** litdata_type_t */ 829 typedef enum { 830 OPS_LDT_BINARY = 'b', 831 OPS_LDT_TEXT = 't', 832 OPS_LDT_UTF8 = 'u', 833 OPS_LDT_LOCAL = 'l', 834 OPS_LDT_LOCAL2 = '1' 835 } __ops_litdata_type_t; 836 837 /** __ops_litdata_header_t */ 838 typedef struct { 839 __ops_litdata_type_t format; 840 char filename[256]; 841 time_t mtime; 842 } __ops_litdata_header_t; 843 844 /** __ops_litdata_body_t */ 845 typedef struct { 846 unsigned length; 847 unsigned char *data; 848 void *mem; /* __ops_memory_t pointer */ 849 } __ops_litdata_body_t; 850 851 /** __ops_mdc_t */ 852 typedef struct { 853 unsigned length; 854 unsigned char *data; 855 } __ops_mdc_t; 856 857 /** __ops_header_var_t */ 858 typedef struct { 859 char *key; 860 char *value; 861 } __ops_header_var_t; 862 863 /** __ops_headers_t */ 864 typedef struct { 865 __ops_header_var_t *headers; 866 unsigned headerc; 867 } __ops_headers_t; 868 869 /** __ops_armour_header_t */ 870 typedef struct { 871 const char *type; 872 __ops_headers_t headers; 873 } __ops_armour_header_t; 874 875 /** __ops_armour_trailer_t */ 876 typedef struct { 877 const char *type; 878 } __ops_armour_trailer_t; 879 880 /** __ops_cleartext_head_t */ 881 typedef struct { 882 __ops_headers_t headers; 883 } __ops_cleartext_head_t; 884 885 /** __ops_cleartext_body_t */ 886 typedef struct { 887 unsigned length; 888 unsigned char data[8192]; /* \todo fix hard-coded value? */ 889 } __ops_cleartext_body_t; 890 891 /** __ops_cleartext_trailer_t */ 892 typedef struct { 893 struct _ops_hash_t *hash; /* This will not have been 894 * finalised, but will have seen all 895 * the cleartext data in canonical 896 * form */ 897 } __ops_cleartext_trailer_t; 898 899 /** __ops_unarmoured_text_t */ 900 typedef struct { 901 unsigned length; 902 unsigned char *data; 903 } __ops_unarmoured_text_t; 904 905 typedef enum { 906 SE_IP_DATA_VERSION = 1 907 } __ops_se_ip_data_version_t; 908 909 typedef enum { 910 OPS_PKSK_V3 = 3 911 } __ops_pk_sesskey_version_t; 912 913 /** __ops_pk_sesskey_params_rsa_t */ 914 typedef struct { 915 BIGNUM *encrypted_m; 916 BIGNUM *m; 917 } __ops_pk_sesskey_params_rsa_t; 918 919 /** __ops_pk_sesskey_params_elgamal_t */ 920 typedef struct { 921 BIGNUM *g_to_k; 922 BIGNUM *encrypted_m; 923 } __ops_pk_sesskey_params_elgamal_t; 924 925 /** __ops_pk_sesskey_params_t */ 926 typedef union { 927 __ops_pk_sesskey_params_rsa_t rsa; 928 __ops_pk_sesskey_params_elgamal_t elgamal; 929 } __ops_pk_sesskey_params_t; 930 931 /** __ops_pk_sesskey_t */ 932 typedef struct { 933 __ops_pk_sesskey_version_t version; 934 unsigned char key_id[OPS_KEY_ID_SIZE]; 935 __ops_pubkey_alg_t alg; 936 __ops_pk_sesskey_params_t params; 937 __ops_symm_alg_t symm_alg; 938 unsigned char key[OPS_MAX_KEY_SIZE]; 939 unsigned short checksum; 940 } __ops_pk_sesskey_t; 941 942 /** __ops_seckey_passphrase_t */ 943 typedef struct { 944 const __ops_seckey_t *seckey; 945 char **passphrase; /* point somewhere that gets filled 946 * in to work around constness of 947 * content */ 948 } __ops_seckey_passphrase_t; 949 950 typedef enum { 951 OPS_SE_IP_V1 = 1 952 } __ops_se_ip_version_t; 953 954 /** __ops_se_ip_data_header_t */ 955 typedef struct { 956 __ops_se_ip_version_t version; 957 } __ops_se_ip_data_header_t; 958 959 /** __ops_se_ip_data_body_t */ 960 typedef struct { 961 unsigned length; 962 unsigned char *data; /* \todo remember to free this */ 963 } __ops_se_ip_data_body_t; 964 965 /** __ops_se_data_body_t */ 966 typedef struct { 967 unsigned length; 968 unsigned char data[8192]; /* \todo parameterise this! */ 969 } __ops_se_data_body_t; 970 971 /** __ops_get_seckey_t */ 972 typedef struct { 973 const __ops_seckey_t **seckey; 974 const __ops_pk_sesskey_t *pk_sesskey; 975 } __ops_get_seckey_t; 976 977 /** __ops_parser_union_content_t */ 978 typedef union { 979 __ops_parser_error_t error; 980 __ops_parser_errcode_t errcode; 981 __ops_ptag_t ptag; 982 __ops_pubkey_t pubkey; 983 __ops_trust_t trust; 984 __ops_userid_t userid; 985 __ops_userattr_t userattr; 986 __ops_sig_t sig; 987 __ops_ss_raw_t ss_raw; 988 __ops_ss_trust_t ss_trust; 989 __ops_ss_revocable_t ss_revocable; 990 __ops_ss_time_t ss_time; 991 __ops_ss_key_id_t ss_issuer; 992 __ops_ss_notation_t ss_notation; 993 __ops_subpacket_t packet; 994 __ops_compressed_t compressed; 995 __ops_one_pass_sig_t one_pass_sig; 996 __ops_ss_skapref_t ss_skapref; 997 __ops_ss_hashpref_t ss_hashpref; 998 __ops_ss_zpref_t ss_zpref; 999 __ops_ss_key_flags_t ss_key_flags; 1000 __ops_ss_key_server_prefs_t ss_key_server_prefs; 1001 __ops_ss_primary_userid_t ss_primary_userid; 1002 __ops_ss_regexp_t ss_regexp; 1003 __ops_ss_policy_t ss_policy; 1004 __ops_ss_keyserv_t ss_keyserv; 1005 __ops_ss_revocation_key_t ss_revocation_key; 1006 __ops_ss_userdef_t ss_userdef; 1007 __ops_ss_unknown_t ss_unknown; 1008 __ops_litdata_header_t litdata_header; 1009 __ops_litdata_body_t litdata_body; 1010 __ops_mdc_t mdc; 1011 __ops_ss_features_t ss_features; 1012 __ops_ss_sig_target_t ss_sig_target; 1013 __ops_ss_embedded_sig_t ss_embedded_sig; 1014 __ops_ss_revocation_t ss_revocation; 1015 __ops_seckey_t seckey; 1016 __ops_userid_t ss_signer; 1017 __ops_armour_header_t armour_header; 1018 __ops_armour_trailer_t armour_trailer; 1019 __ops_cleartext_head_t cleartext_head; 1020 __ops_cleartext_body_t cleartext_body; 1021 __ops_cleartext_trailer_t cleartext_trailer; 1022 __ops_unarmoured_text_t unarmoured_text; 1023 __ops_pk_sesskey_t pk_sesskey; 1024 __ops_seckey_passphrase_t skey_passphrase; 1025 __ops_se_ip_data_header_t se_ip_data_header; 1026 __ops_se_ip_data_body_t se_ip_data_body; 1027 __ops_se_data_body_t se_data_body; 1028 __ops_get_seckey_t get_seckey; 1029 } __ops_contents_t; 1030 1031 /** __ops_packet_t */ 1032 struct __ops_packet_t { 1033 __ops_content_tag_t tag; /* type of contents */ 1034 unsigned char critical; /* for sig subpackets */ 1035 __ops_contents_t u; /* union for contents */ 1036 }; 1037 1038 /** __ops_fingerprint_t */ 1039 typedef struct { 1040 unsigned char fingerprint[OPS_FINGERPRINT_SIZE]; 1041 unsigned length; 1042 } __ops_fingerprint_t; 1043 1044 void __ops_init(void); 1045 void __ops_finish(void); 1046 void __ops_keyid(unsigned char *, const size_t, const __ops_pubkey_t *); 1047 void __ops_fingerprint(__ops_fingerprint_t *, const __ops_pubkey_t *); 1048 void __ops_pubkey_free(__ops_pubkey_t *); 1049 void __ops_userid_free(__ops_userid_t *); 1050 void __ops_userattr_free(__ops_userattr_t *); 1051 void __ops_sig_free(__ops_sig_t *); 1052 void __ops_trust_free(__ops_trust_t *); 1053 void __ops_ss_skapref_free(__ops_ss_skapref_t *); 1054 void __ops_ss_hashpref_free(__ops_ss_hashpref_t *); 1055 void __ops_ss_zpref_free(__ops_ss_zpref_t *); 1056 void __ops_ss_key_flags_free(__ops_ss_key_flags_t *); 1057 void __ops_ss_key_server_prefs_free(__ops_ss_key_server_prefs_t *); 1058 void __ops_ss_features_free(__ops_ss_features_t *); 1059 void __ops_ss_notation_free(__ops_ss_notation_t *); 1060 void __ops_ss_policy_free(__ops_ss_policy_t *); 1061 void __ops_ss_keyserv_free(__ops_ss_keyserv_t *); 1062 void __ops_ss_regexp_free(__ops_ss_regexp_t *); 1063 void __ops_ss_userdef_free(__ops_ss_userdef_t *); 1064 void __ops_ss_reserved_free(__ops_ss_unknown_t *); 1065 void __ops_ss_revocation_free(__ops_ss_revocation_t *); 1066 void __ops_ss_sig_target_free(__ops_ss_sig_target_t *); 1067 void __ops_ss_embedded_sig_free(__ops_ss_embedded_sig_t *); 1068 1069 void __ops_subpacket_free(__ops_subpacket_t *); 1070 void __ops_parser_content_free(__ops_packet_t *); 1071 void __ops_seckey_free(__ops_seckey_t *); 1072 void __ops_pk_sesskey_free(__ops_pk_sesskey_t *); 1073 1074 int __ops_print_packet(__ops_printstate_t *, const __ops_packet_t *); 1075 1076 #define DYNARRAY(type, arr) \ 1077 unsigned arr##c; unsigned arr##vsize; type *arr##s 1078 1079 #define EXPAND_ARRAY(str, arr) do { \ 1080 if (str->arr##c == str->arr##vsize) { \ 1081 void *__newarr; \ 1082 str->arr##vsize = (str->arr##vsize * 2) + 10; \ 1083 if ((__newarr = realloc(str->arr##s, \ 1084 str->arr##vsize * sizeof(*str->arr##s))) == NULL) { \ 1085 (void) fprintf(stderr, "EXPAND_ARRAY - bad realloc\n"); \ 1086 } \ 1087 str->arr##s = __newarr; \ 1088 } \ 1089 } while(/*CONSTCOND*/0) 1090 1091 /** __ops_keydata_key_t 1092 */ 1093 typedef union { 1094 __ops_pubkey_t pubkey; 1095 __ops_seckey_t seckey; 1096 } __ops_keydata_key_t; 1097 1098 1099 /** sigpacket_t */ 1100 typedef struct { 1101 __ops_userid_t *userid; 1102 __ops_subpacket_t *packet; 1103 } sigpacket_t; 1104 1105 /* XXX: gonna have to expand this to hold onto subkeys, too... */ 1106 /** \struct __ops_keydata 1107 * \todo expand to hold onto subkeys 1108 */ 1109 struct __ops_key_t { 1110 DYNARRAY(__ops_userid_t, uid); 1111 DYNARRAY(__ops_subpacket_t, packet); 1112 DYNARRAY(sigpacket_t, sig); 1113 unsigned char key_id[OPS_KEY_ID_SIZE]; 1114 __ops_fingerprint_t fingerprint; 1115 __ops_content_tag_t type; 1116 __ops_keydata_key_t key; 1117 }; 1118 1119 #define MDC_PKT_TAG 0xd3 1120 1121 #endif /* PACKET_H_ */ 1122