26678cfe61d6a21893b901796c0399552d6893c8
[openssl.git] / crypto / include / internal / x509_int.h
1 /* x509_int.h */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2015.
5  */
6 /* ====================================================================
7  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 /* Internal X509 structures and functions: not for application use */
61
62 /* Note: unless otherwise stated a field pointer is mandatory and should
63  * never be set to NULL: the ASN.1 code and accessors rely on mandatory
64  * fields never being NULL.
65  */
66
67 /*
68  * name entry structure, equivalent to AttributeTypeAndValue defined
69  * in RFC5280 et al.
70  */
71 struct X509_name_entry_st {
72     ASN1_OBJECT *object;        /* AttributeType */
73     ASN1_STRING *value;         /* AttributeValue */
74     int set;                    /* index of RDNSequence for this entry */
75     int size;                   /* temp variable */
76 };
77
78 /* Name from RFC 5280. */
79 struct X509_name_st {
80     STACK_OF(X509_NAME_ENTRY) *entries; /* DN components */
81     int modified;               /* true if 'bytes' needs to be built */
82     BUF_MEM *bytes;             /* cached encoding: cannot be NULL */
83     /* canonical encoding used for rapid Name comparison */
84     unsigned char *canon_enc;
85     int canon_enclen;
86 } /* X509_NAME */ ;
87
88 /* PKCS#10 certificate request */
89
90 struct X509_req_info_st {
91     ASN1_ENCODING enc;          /* cached encoding of signed part */
92     ASN1_INTEGER *version;      /* version, defaults to v1(0) so can be NULL */
93     X509_NAME *subject;         /* certificate request DN */
94     X509_PUBKEY *pubkey;        /* public key of request */
95     /*
96      * Zero or more attributes.
97      * NB: although attributes is a mandatory field some broken
98      * encodings omit it so this may be NULL in that case.
99      */
100     STACK_OF(X509_ATTRIBUTE) *attributes;
101 };
102
103 struct X509_req_st {
104     X509_REQ_INFO req_info;     /* signed certificate request data */
105     X509_ALGOR sig_alg;         /* signature algorithm */
106     ASN1_BIT_STRING *signature; /* signature */
107     int references;
108 };
109
110 struct X509_crl_info_st {
111     ASN1_INTEGER *version;      /* version: defaults to v1(0) so may be NULL */
112     X509_ALGOR sig_alg;         /* signagture algorithm */
113     X509_NAME *issuer;          /* CRL issuer name */
114     ASN1_TIME *lastUpdate;      /* lastUpdate field */
115     ASN1_TIME *nextUpdate;      /* nextUpdate field: optional */
116     STACK_OF(X509_REVOKED) *revoked; /* revoked entries: optional */
117     STACK_OF(X509_EXTENSION) *extensions;   /* extensions: optional */
118     ASN1_ENCODING enc;          /* encoding of signed portion of CRL */
119 };
120
121 struct X509_crl_st {
122     X509_CRL_INFO crl;          /* signed CRL data */
123     X509_ALGOR sig_alg;         /* CRL signature algorithm */
124     ASN1_BIT_STRING *signature; /* CRL signature */
125     int references;
126     int flags;
127     /*
128      * Cached copies of decoded extension values, since extensions
129      * are optional any of these can be NULL.
130      */
131     AUTHORITY_KEYID *akid;
132     ISSUING_DIST_POINT *idp;
133     /* Convenient breakdown of IDP */
134     int idp_flags;
135     int idp_reasons;
136     /* CRL and base CRL numbers for delta processing */
137     ASN1_INTEGER *crl_number;
138     ASN1_INTEGER *base_crl_number;
139     STACK_OF(GENERAL_NAMES) *issuers;
140     /* hash of CRL */
141     unsigned char sha1_hash[SHA_DIGEST_LENGTH];
142     /* alternative method to handle this CRL */
143     const X509_CRL_METHOD *meth;
144     void *meth_data;
145 };
146
147 struct x509_revoked_st {
148     ASN1_INTEGER *serialNumber; /* revoked entry serial number */
149     ASN1_TIME *revocationDate;  /* revocation date */
150     STACK_OF(X509_EXTENSION) *extensions;   /* CRL entry extensions: optional */
151     /* decoded value of CRLissuer extension: set if indirect CRL */
152     STACK_OF(GENERAL_NAME) *issuer;
153     /* revocation reason: set to CRL_REASON_NONE if reason extension absent */
154     int reason;
155     /*
156      * CRL entries are reordered for faster lookup of serial numbers. This
157      * field contains the original load sequence for this entry.
158      */
159     int sequence;
160 };
161
162 /*
163  * This stuff is certificate "auxiliary info": it contains details which are
164  * useful in certificate stores and databases. When used this is tagged onto
165  * the end of the certificate itself. OpenSSL specific structure not defined
166  * in any RFC.
167  */
168
169 struct x509_cert_aux_st {
170     STACK_OF(ASN1_OBJECT) *trust; /* trusted uses */
171     STACK_OF(ASN1_OBJECT) *reject; /* rejected uses */
172     ASN1_UTF8STRING *alias;     /* "friendly name" */
173     ASN1_OCTET_STRING *keyid;   /* key id of private key */
174     STACK_OF(X509_ALGOR) *other; /* other unspecified info */
175 };