Support the TLS Feature (aka Must Staple) X.509v3 extension (RFC7633).
[openssl.git] / crypto / x509v3 / v3_tlsf.c
1 /* v3_tlsf.c */
2 /*
3  * Written by Rob Stradling (rob@comodo.com) for the OpenSSL project 2015.
4  */
5 /* ====================================================================
6  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
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  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include <stdio.h>
60 #include "internal/cryptlib.h"
61 #include "internal/o_str.h"
62 #include <openssl/asn1t.h>
63 #include <openssl/conf.h>
64 #include <openssl/x509v3.h>
65 #include "ext_dat.h"
66
67 static STACK_OF(CONF_VALUE) *i2v_TLS_FEATURE(const X509V3_EXT_METHOD *method,
68                                              TLS_FEATURE *tls_feature,
69                                              STACK_OF(CONF_VALUE) *ext_list);
70 static TLS_FEATURE *v2i_TLS_FEATURE(const X509V3_EXT_METHOD *method,
71                                     X509V3_CTX *ctx,
72                                     STACK_OF(CONF_VALUE) *nval);
73
74 ASN1_ITEM_TEMPLATE(TLS_FEATURE) =
75         ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, TLS_FEATURE, ASN1_INTEGER)
76 static_ASN1_ITEM_TEMPLATE_END(TLS_FEATURE)
77
78 IMPLEMENT_ASN1_ALLOC_FUNCTIONS(TLS_FEATURE)
79
80 const X509V3_EXT_METHOD v3_tls_feature = {
81     NID_tlsfeature, 0,
82     ASN1_ITEM_ref(TLS_FEATURE),
83     0, 0, 0, 0,
84     0, 0,
85     (X509V3_EXT_I2V)i2v_TLS_FEATURE,
86     (X509V3_EXT_V2I)v2i_TLS_FEATURE,
87     0, 0,
88     NULL
89 };
90
91
92 typedef struct {
93     long num;
94     const char *name;
95 } TLS_FEATURE_NAME;
96
97 static TLS_FEATURE_NAME tls_feature_tbl[] = {
98     { 5, "status_request" },
99     { 17, "status_request_v2" }
100 };
101
102 /*
103  * i2v_TLS_FEATURE converts the TLS_FEATURE structure tls_feature into the
104  * STACK_OF(CONF_VALUE) structure ext_list. STACK_OF(CONF_VALUE) is the format
105  * used by the CONF library to represent a multi-valued extension.  ext_list is
106  * returned.
107  */
108 static STACK_OF(CONF_VALUE) *i2v_TLS_FEATURE(const X509V3_EXT_METHOD *method,
109                                              TLS_FEATURE *tls_feature,
110                                              STACK_OF(CONF_VALUE) *ext_list)
111 {
112     int i;
113     size_t j;
114     ASN1_INTEGER *ai;
115     long tlsextid;
116     for (i = 0; i < sk_ASN1_INTEGER_num(tls_feature); i++) {
117         ai = sk_ASN1_INTEGER_value(tls_feature, i);
118         tlsextid = ASN1_INTEGER_get(ai);
119         for (j = 0; j < OSSL_NELEM(tls_feature_tbl); j++)
120             if (tlsextid == tls_feature_tbl[j].num)
121                 break;
122         if (j < OSSL_NELEM(tls_feature_tbl))
123             X509V3_add_value(NULL, tls_feature_tbl[j].name, &ext_list);
124         else
125             X509V3_add_value_int(NULL, ai, &ext_list);
126     }
127     return ext_list;
128 }
129
130 /*
131  * v2i_TLS_FEATURE converts the multi-valued extension nval into a TLS_FEATURE
132  * structure, which is returned if the conversion is successful.  In case of
133  * error, NULL is returned.
134  */
135 static TLS_FEATURE *v2i_TLS_FEATURE(const X509V3_EXT_METHOD *method,
136                                     X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval)
137 {
138     TLS_FEATURE *tlsf;
139     char *extval, *endptr;
140     ASN1_INTEGER *ai;
141     CONF_VALUE *val;
142     int i;
143     size_t j;
144     long tlsextid;
145
146     if ((tlsf = sk_ASN1_INTEGER_new_null()) == NULL) {
147         X509V3err(X509V3_F_V2I_TLS_FEATURE, ERR_R_MALLOC_FAILURE);
148         return NULL;
149     }
150
151     for (i = 0; i < sk_CONF_VALUE_num(nval); i++) {
152         val = sk_CONF_VALUE_value(nval, i);
153         if (val->value)
154             extval = val->value;
155         else
156             extval = val->name;
157
158         for (j = 0; j < OSSL_NELEM(tls_feature_tbl); j++)
159             if (OPENSSL_strcasecmp(extval, tls_feature_tbl[j].name) == 0)
160                 break;
161         if (j < OSSL_NELEM(tls_feature_tbl))
162             tlsextid = tls_feature_tbl[j].num;
163         else {
164             tlsextid = strtol(extval, &endptr, 10);
165             if (((*endptr) != '\0') || (extval == endptr) || (tlsextid < 0) ||
166                 (tlsextid > 65535)) {
167                 X509V3err(X509V3_F_V2I_TLS_FEATURE, X509V3_R_INVALID_SYNTAX);
168                 X509V3_conf_err(val);
169                 goto err;
170             }
171         }
172
173         ai = ASN1_INTEGER_new();
174         if (ai == NULL) {
175             X509V3err(X509V3_F_V2I_TLS_FEATURE, ERR_R_MALLOC_FAILURE);
176             goto err;
177         }
178         ASN1_INTEGER_set(ai, tlsextid);
179         sk_ASN1_INTEGER_push(tlsf, ai);
180     }
181     return tlsf;
182
183  err:
184     sk_ASN1_INTEGER_pop_free(tlsf, ASN1_INTEGER_free);
185     return NULL;
186 }