/********************************************************************************/ /* */ /* Macro and Structure Definitions for the X509 Commands and Functions. */ /* Written by Ken Goldman */ /* IBM Thomas J. Watson Research Center */ /* $Id: TpmAsn1.h 1519 2019-11-15 20:43:51Z kgoldman $ */ /* */ /* Licenses and Notices */ /* */ /* 1. Copyright Licenses: */ /* */ /* - Trusted Computing Group (TCG) grants to the user of the source code in */ /* this specification (the "Source Code") a worldwide, irrevocable, */ /* nonexclusive, royalty free, copyright license to reproduce, create */ /* derivative works, distribute, display and perform the Source Code and */ /* derivative works thereof, and to grant others the rights granted herein. */ /* */ /* - The TCG grants to the user of the other parts of the specification */ /* (other than the Source Code) the rights to reproduce, distribute, */ /* display, and perform the specification solely for the purpose of */ /* developing products based on such documents. */ /* */ /* 2. Source Code Distribution Conditions: */ /* */ /* - Redistributions of Source Code must retain the above copyright licenses, */ /* this list of conditions and the following disclaimers. */ /* */ /* - Redistributions in binary form must reproduce the above copyright */ /* licenses, this list of conditions and the following disclaimers in the */ /* documentation and/or other materials provided with the distribution. */ /* */ /* 3. Disclaimers: */ /* */ /* - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */ /* LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */ /* RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */ /* THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE. */ /* Contact TCG Administration (admin@trustedcomputinggroup.org) for */ /* information on specification licensing rights available through TCG */ /* membership agreements. */ /* */ /* - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED */ /* WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR */ /* FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR */ /* NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY */ /* OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. */ /* */ /* - Without limitation, TCG and its members and licensors disclaim all */ /* liability, including liability for infringement of any proprietary */ /* rights, relating to use of information in this specification and to the */ /* implementation of this specification, and TCG disclaims all liability for */ /* cost of procurement of substitute goods or services, lost profits, loss */ /* of use, loss of data or any incidental, consequential, direct, indirect, */ /* or special damages, whether under contract, tort, warranty or otherwise, */ /* arising in any way out of use or reliance upon this specification or any */ /* information herein. */ /* */ /* (c) Copyright IBM Corp. and others, 2019 */ /* */ /********************************************************************************/ // 10.1.15 TpmAsn1.h // 10.1.15.1 Introduction // This file contains the macro and structure definitions for the X509 commands and functions. #ifndef _TPMASN1_H_ #define _TPMASN1_H_ // 10.1.15.2 Includes #include "Tpm.h" #include "OIDs.h" // 10.1.15.3 Defined Constants // 10.1.15.3.1 ASN.1 Universal Types (Class 00b #define ASN1_EOC 0x00 #define ASN1_BOOLEAN 0x01 #define ASN1_INTEGER 0x02 #define ASN1_BITSTRING 0x03 #define ASN1_OCTET_STRING 0x04 #define ASN1_NULL 0x05 #define ASN1_OBJECT_IDENTIFIER 0x06 #define ASN1_OBJECT_DESCRIPTOR 0x07 #define ASN1_EXTERNAL 0x08 #define ASN1_REAL 0x09 #define ASN1_ENUMERATED 0x0A #define ASN1_EMBEDDED 0x0B #define ASN1_UTF8String 0x0C #define ASN1_RELATIVE_OID 0x0D #define ASN1_SEQUENCE 0x10 // Primitive + Constructed + 0x10 #define ASN1_SET 0x11 // Primitive + Constructed + 0x11 #define ASN1_NumericString 0x12 #define ASN1_PrintableString 0x13 #define ASN1_T61String 0x14 #define ASN1_VideoString 0x15 #define ASN1_IA5String 0x16 #define ASN1_UTCTime 0x17 #define ASN1_GeneralizeTime 0x18 #define ASN1_VisibleString 0x1A #define ASN1_GeneralString 0x1B #define ASN1_UniversalString 0x1C #define ASN1_CHARACTER STRING 0x1D #define ASN1_BMPString 0x1E #define ASN1_CONSTRUCTED 0x20 #define ASN1_APPLICAIION_SPECIFIC 0xA0 #define ASN1_CONSTRUCTED_SEQUENCE (ASN1_SEQUENCE + ASN1_CONSTRUCTED) #define MAX_DEPTH 10 // maximum push depth for marshaling context. // 10.1.15.4 Macros // 10.1.15.4.1 Unmarshaling Macros #ifndef VERIFY #define VERIFY(_X_) {if(!(_X_)) goto Error; } #endif // Checks the validity of the size making sure that there is no wrap around #define CHECK_SIZE(context, length) \ VERIFY( (((length) + (context)->offset) >= (context)->offset) \ && (((length) + (context)->offset) <= (context)->size)) #define NEXT_OCTET(context) ((context)->buffer[(context)->offset++]) #define PEEK_NEXT(context) ((context)->buffer[(context)->offset]) // 10.1.15.4.2 Marshaling Macros Marshaling works in reverse order. The offset is set to the top of // the buffer and, as the buffer is filled, offset counts down to zero. When the full thing is // encoded it can be moved to the top of the buffer. This happens when the last context is closed. #define CHECK_SPACE(context, length) VERIFY(context->offset > length) // 10.1.15.5 Structures typedef struct ASN1UnmarshalContext { BYTE *buffer; // pointer to the buffer INT16 size; // size of the buffer (a negative number indicates // a parsing failure). INT16 offset; // current offset into the buffer (a negative number // indicates a parsing failure). Not used BYTE tag; // The last unmarshaled tag } ASN1UnmarshalContext; typedef struct ASN1MarshalContext { BYTE *buffer; // pointer to the start of the buffer INT16 offset; // place on the top where the last entry was added // items are added from the bottom up. INT16 end; // the end offset of the current value INT16 depth; // how many pushed end values. INT16 ends[MAX_DEPTH]; } ASN1MarshalContext; #endif // _TPMASN1_H_