a_strnid.c revision 1.20
1/* $OpenBSD: a_strnid.c,v 1.20 2017/01/21 04:31:25 jsing Exp $ */ 2/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL 3 * project 1999. 4 */ 5/* ==================================================================== 6 * Copyright (c) 1999 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 <ctype.h> 60#include <stdio.h> 61#include <string.h> 62 63#include <openssl/asn1.h> 64#include <openssl/err.h> 65#include <openssl/objects.h> 66 67static STACK_OF(ASN1_STRING_TABLE) *stable = NULL; 68static void st_free(ASN1_STRING_TABLE *tbl); 69static int sk_table_cmp(const ASN1_STRING_TABLE * const *a, 70 const ASN1_STRING_TABLE * const *b); 71 72 73/* This is the global mask for the mbstring functions: this is use to 74 * mask out certain types (such as BMPString and UTF8String) because 75 * certain software (e.g. Netscape) has problems with them. 76 */ 77 78static unsigned long global_mask = B_ASN1_UTF8STRING; 79 80void 81ASN1_STRING_set_default_mask(unsigned long mask) 82{ 83 global_mask = mask; 84} 85 86unsigned long 87ASN1_STRING_get_default_mask(void) 88{ 89 return global_mask; 90} 91 92/* This function sets the default to various "flavours" of configuration. 93 * based on an ASCII string. Currently this is: 94 * MASK:XXXX : a numerical mask value. 95 * nobmp : Don't use BMPStrings (just Printable, T61). 96 * pkix : PKIX recommendation in RFC2459. 97 * utf8only : only use UTF8Strings (RFC2459 recommendation for 2004). 98 * default: the default value, Printable, T61, BMP. 99 */ 100 101int 102ASN1_STRING_set_default_mask_asc(const char *p) 103{ 104 unsigned long mask; 105 char *end; 106 107 if (!strncmp(p, "MASK:", 5)) { 108 if (!p[5]) 109 return 0; 110 mask = strtoul(p + 5, &end, 0); 111 if (*end) 112 return 0; 113 } else if (!strcmp(p, "nombstr")) 114 mask = ~((unsigned long)(B_ASN1_BMPSTRING|B_ASN1_UTF8STRING)); 115 else if (!strcmp(p, "pkix")) 116 mask = ~((unsigned long)B_ASN1_T61STRING); 117 else if (!strcmp(p, "utf8only")) 118 mask = B_ASN1_UTF8STRING; 119 else if (!strcmp(p, "default")) 120 mask = 0xFFFFFFFFL; 121 else 122 return 0; 123 ASN1_STRING_set_default_mask(mask); 124 return 1; 125} 126 127/* The following function generates an ASN1_STRING based on limits in a table. 128 * Frequently the types and length of an ASN1_STRING are restricted by a 129 * corresponding OID. For example certificates and certificate requests. 130 */ 131 132ASN1_STRING * 133ASN1_STRING_set_by_NID(ASN1_STRING **out, const unsigned char *in, int inlen, 134 int inform, int nid) 135{ 136 ASN1_STRING_TABLE *tbl; 137 ASN1_STRING *str = NULL; 138 unsigned long mask; 139 int ret; 140 if (!out) 141 out = &str; 142 tbl = ASN1_STRING_TABLE_get(nid); 143 if (tbl) { 144 mask = tbl->mask; 145 if (!(tbl->flags & STABLE_NO_MASK)) 146 mask &= global_mask; 147 ret = ASN1_mbstring_ncopy(out, in, inlen, inform, mask, 148 tbl->minsize, tbl->maxsize); 149 } else 150 ret = ASN1_mbstring_copy(out, in, inlen, inform, 151 DIRSTRING_TYPE & global_mask); 152 if (ret <= 0) 153 return NULL; 154 return *out; 155} 156 157/* Now the tables and helper functions for the string table: 158 */ 159 160/* size limits: this stuff is taken straight from RFC3280 */ 161 162#define ub_name 32768 163#define ub_common_name 64 164#define ub_locality_name 128 165#define ub_state_name 128 166#define ub_organization_name 64 167#define ub_organization_unit_name 64 168#define ub_title 64 169#define ub_email_address 128 170#define ub_serial_number 64 171 172 173/* This table must be kept in NID order */ 174 175static const ASN1_STRING_TABLE tbl_standard[] = { 176 {NID_commonName, 1, ub_common_name, DIRSTRING_TYPE, 0}, 177 {NID_countryName, 2, 2, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK}, 178 {NID_localityName, 1, ub_locality_name, DIRSTRING_TYPE, 0}, 179 {NID_stateOrProvinceName, 1, ub_state_name, DIRSTRING_TYPE, 0}, 180 {NID_organizationName, 1, ub_organization_name, DIRSTRING_TYPE, 0}, 181 {NID_organizationalUnitName, 1, ub_organization_unit_name, DIRSTRING_TYPE, 0}, 182 {NID_pkcs9_emailAddress, 1, ub_email_address, B_ASN1_IA5STRING, STABLE_NO_MASK}, 183 {NID_pkcs9_unstructuredName, 1, -1, PKCS9STRING_TYPE, 0}, 184 {NID_pkcs9_challengePassword, 1, -1, PKCS9STRING_TYPE, 0}, 185 {NID_pkcs9_unstructuredAddress, 1, -1, DIRSTRING_TYPE, 0}, 186 {NID_givenName, 1, ub_name, DIRSTRING_TYPE, 0}, 187 {NID_surname, 1, ub_name, DIRSTRING_TYPE, 0}, 188 {NID_initials, 1, ub_name, DIRSTRING_TYPE, 0}, 189 {NID_serialNumber, 1, ub_serial_number, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK}, 190 {NID_friendlyName, -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK}, 191 {NID_name, 1, ub_name, DIRSTRING_TYPE, 0}, 192 {NID_dnQualifier, -1, -1, B_ASN1_PRINTABLESTRING, STABLE_NO_MASK}, 193 {NID_domainComponent, 1, -1, B_ASN1_IA5STRING, STABLE_NO_MASK}, 194 {NID_ms_csp_name, -1, -1, B_ASN1_BMPSTRING, STABLE_NO_MASK} 195}; 196 197static int 198sk_table_cmp(const ASN1_STRING_TABLE * const *a, 199 const ASN1_STRING_TABLE * const *b) 200{ 201 return (*a)->nid - (*b)->nid; 202} 203 204static int table_cmp_BSEARCH_CMP_FN(const void *, const void *); 205static int table_cmp(ASN1_STRING_TABLE const *, ASN1_STRING_TABLE const *); 206static ASN1_STRING_TABLE *OBJ_bsearch_table(ASN1_STRING_TABLE *key, ASN1_STRING_TABLE const *base, int num); 207 208static int 209table_cmp(const ASN1_STRING_TABLE *a, const ASN1_STRING_TABLE *b) 210{ 211 return a->nid - b->nid; 212} 213 214 215static int 216table_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_) 217{ 218 ASN1_STRING_TABLE const *a = a_; 219 ASN1_STRING_TABLE const *b = b_; 220 return table_cmp(a, b); 221} 222 223static ASN1_STRING_TABLE * 224OBJ_bsearch_table(ASN1_STRING_TABLE *key, ASN1_STRING_TABLE const *base, int num) 225{ 226 return (ASN1_STRING_TABLE *)OBJ_bsearch_(key, base, num, sizeof(ASN1_STRING_TABLE), 227 table_cmp_BSEARCH_CMP_FN); 228} 229 230ASN1_STRING_TABLE * 231ASN1_STRING_TABLE_get(int nid) 232{ 233 int idx; 234 ASN1_STRING_TABLE *ttmp; 235 ASN1_STRING_TABLE fnd; 236 237 fnd.nid = nid; 238 ttmp = OBJ_bsearch_table(&fnd, tbl_standard, 239 sizeof(tbl_standard)/sizeof(ASN1_STRING_TABLE)); 240 if (ttmp) 241 return ttmp; 242 if (!stable) 243 return NULL; 244 idx = sk_ASN1_STRING_TABLE_find(stable, &fnd); 245 if (idx < 0) 246 return NULL; 247 return sk_ASN1_STRING_TABLE_value(stable, idx); 248} 249 250int 251ASN1_STRING_TABLE_add(int nid, long minsize, long maxsize, unsigned long mask, 252 unsigned long flags) 253{ 254 ASN1_STRING_TABLE *tmp; 255 char new_nid = 0; 256 257 flags &= ~STABLE_FLAGS_MALLOC; 258 if (!stable) 259 stable = sk_ASN1_STRING_TABLE_new(sk_table_cmp); 260 if (!stable) { 261 ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD, ERR_R_MALLOC_FAILURE); 262 return 0; 263 } 264 if (!(tmp = ASN1_STRING_TABLE_get(nid))) { 265 tmp = malloc(sizeof(ASN1_STRING_TABLE)); 266 if (!tmp) { 267 ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD, 268 ERR_R_MALLOC_FAILURE); 269 return 0; 270 } 271 tmp->flags = flags | STABLE_FLAGS_MALLOC; 272 tmp->nid = nid; 273 new_nid = 1; 274 } else tmp->flags = (tmp->flags & STABLE_FLAGS_MALLOC) | flags; 275 if (minsize != -1) 276 tmp->minsize = minsize; 277 if (maxsize != -1) 278 tmp->maxsize = maxsize; 279 tmp->mask = mask; 280 if (new_nid) { 281 if (sk_ASN1_STRING_TABLE_push(stable, tmp) == 0) { 282 free(tmp); 283 ASN1err(ASN1_F_ASN1_STRING_TABLE_ADD, 284 ERR_R_MALLOC_FAILURE); 285 return 0; 286 } 287 } 288 return 1; 289} 290 291void 292ASN1_STRING_TABLE_cleanup(void) 293{ 294 STACK_OF(ASN1_STRING_TABLE) *tmp; 295 296 tmp = stable; 297 if (!tmp) 298 return; 299 stable = NULL; 300 sk_ASN1_STRING_TABLE_pop_free(tmp, st_free); 301} 302 303static void 304st_free(ASN1_STRING_TABLE *tbl) 305{ 306 if (tbl->flags & STABLE_FLAGS_MALLOC) 307 free(tbl); 308} 309