Coverage Report

Created: 2025-06-11 06:40

/src/boringssl/crypto/x509/x509name.cc
Line
Count
Source (jump to first uncovered line)
1
// Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
//     https://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
15
#include <string.h>
16
17
#include <openssl/asn1.h>
18
#include <openssl/bytestring.h>
19
#include <openssl/err.h>
20
#include <openssl/evp.h>
21
#include <openssl/obj.h>
22
#include <openssl/stack.h>
23
#include <openssl/x509.h>
24
25
#include "../internal.h"
26
#include "internal.h"
27
28
29
int X509_NAME_get_text_by_NID(const X509_NAME *name, int nid, char *buf,
30
0
                              int len) {
31
0
  const ASN1_OBJECT *obj;
32
33
0
  obj = OBJ_nid2obj(nid);
34
0
  if (obj == NULL) {
35
0
    return -1;
36
0
  }
37
0
  return (X509_NAME_get_text_by_OBJ(name, obj, buf, len));
38
0
}
39
40
int X509_NAME_get_text_by_OBJ(const X509_NAME *name, const ASN1_OBJECT *obj,
41
0
                              char *buf, int len) {
42
0
  int i = X509_NAME_get_index_by_OBJ(name, obj, -1);
43
0
  if (i < 0) {
44
0
    return -1;
45
0
  }
46
0
  const ASN1_STRING *data =
47
0
      X509_NAME_ENTRY_get_data(X509_NAME_get_entry(name, i));
48
0
  unsigned char *text = NULL;
49
0
  int ret = -1;
50
0
  int text_len = ASN1_STRING_to_UTF8(&text, data);
51
  // Fail if we could not encode as UTF-8.
52
0
  if (text_len < 0) {
53
0
    goto out;
54
0
  }
55
0
  CBS cbs;
56
0
  CBS_init(&cbs, text, text_len);
57
  // Fail if the UTF-8 encoding constains a 0 byte because this is
58
  // returned as a C string and callers very often do not check.
59
0
  if (CBS_contains_zero_byte(&cbs)) {
60
0
    goto out;
61
0
  }
62
  // We still support the "pass NULL to find out how much" API
63
0
  if (buf != NULL) {
64
0
    if (text_len >= len || len <= 0 ||
65
0
        !CBS_copy_bytes(&cbs, (uint8_t *)buf, text_len)) {
66
0
      goto out;
67
0
    }
68
    // It must be a C string
69
0
    buf[text_len] = '\0';
70
0
  }
71
0
  ret = text_len;
72
73
0
out:
74
0
  OPENSSL_free(text);
75
0
  return ret;
76
0
}
77
78
241
int X509_NAME_entry_count(const X509_NAME *name) {
79
241
  if (name == NULL) {
80
0
    return 0;
81
0
  }
82
241
  return (int)sk_X509_NAME_ENTRY_num(name->entries);
83
241
}
84
85
0
int X509_NAME_get_index_by_NID(const X509_NAME *name, int nid, int lastpos) {
86
0
  const ASN1_OBJECT *obj;
87
88
0
  obj = OBJ_nid2obj(nid);
89
0
  if (obj == NULL) {
90
0
    return -2;
91
0
  }
92
0
  return X509_NAME_get_index_by_OBJ(name, obj, lastpos);
93
0
}
94
95
// NOTE: you should be passsing -1, not 0 as lastpos
96
int X509_NAME_get_index_by_OBJ(const X509_NAME *name, const ASN1_OBJECT *obj,
97
0
                               int lastpos) {
98
0
  if (name == NULL) {
99
0
    return -1;
100
0
  }
101
0
  if (lastpos < 0) {
102
0
    lastpos = -1;
103
0
  }
104
0
  const STACK_OF(X509_NAME_ENTRY) *sk = name->entries;
105
0
  int n = (int)sk_X509_NAME_ENTRY_num(sk);
106
0
  for (lastpos++; lastpos < n; lastpos++) {
107
0
    const X509_NAME_ENTRY *ne = sk_X509_NAME_ENTRY_value(sk, lastpos);
108
0
    if (OBJ_cmp(ne->object, obj) == 0) {
109
0
      return lastpos;
110
0
    }
111
0
  }
112
0
  return -1;
113
0
}
114
115
1.18k
X509_NAME_ENTRY *X509_NAME_get_entry(const X509_NAME *name, int loc) {
116
1.18k
  if (name == NULL || loc < 0 ||
117
1.18k
      sk_X509_NAME_ENTRY_num(name->entries) <= (size_t)loc) {
118
0
    return NULL;
119
1.18k
  } else {
120
1.18k
    return (sk_X509_NAME_ENTRY_value(name->entries, loc));
121
1.18k
  }
122
1.18k
}
123
124
0
X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc) {
125
0
  if (name == NULL || loc < 0 ||
126
0
      sk_X509_NAME_ENTRY_num(name->entries) <= (size_t)loc) {
127
0
    return NULL;
128
0
  }
129
130
0
  STACK_OF(X509_NAME_ENTRY) *sk = name->entries;
131
0
  X509_NAME_ENTRY *ret = sk_X509_NAME_ENTRY_delete(sk, loc);
132
0
  size_t n = sk_X509_NAME_ENTRY_num(sk);
133
0
  name->modified = 1;
134
0
  if ((size_t)loc == n) {
135
0
    return ret;
136
0
  }
137
138
0
  int set_prev;
139
0
  if (loc != 0) {
140
0
    set_prev = sk_X509_NAME_ENTRY_value(sk, loc - 1)->set;
141
0
  } else {
142
0
    set_prev = ret->set - 1;
143
0
  }
144
0
  int set_next = sk_X509_NAME_ENTRY_value(sk, loc)->set;
145
146
  // If we removed a singleton RDN, update the RDN indices so they are
147
  // consecutive again.
148
0
  if (set_prev + 1 < set_next) {
149
0
    for (size_t i = loc; i < n; i++) {
150
0
      sk_X509_NAME_ENTRY_value(sk, i)->set--;
151
0
    }
152
0
  }
153
0
  return ret;
154
0
}
155
156
int X509_NAME_add_entry_by_OBJ(X509_NAME *name, const ASN1_OBJECT *obj,
157
                               int type, const unsigned char *bytes,
158
0
                               ossl_ssize_t len, int loc, int set) {
159
0
  X509_NAME_ENTRY *ne =
160
0
      X509_NAME_ENTRY_create_by_OBJ(NULL, obj, type, bytes, len);
161
0
  if (!ne) {
162
0
    return 0;
163
0
  }
164
0
  int ret = X509_NAME_add_entry(name, ne, loc, set);
165
0
  X509_NAME_ENTRY_free(ne);
166
0
  return ret;
167
0
}
168
169
int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type,
170
                               const unsigned char *bytes, ossl_ssize_t len,
171
0
                               int loc, int set) {
172
0
  X509_NAME_ENTRY *ne =
173
0
      X509_NAME_ENTRY_create_by_NID(NULL, nid, type, bytes, len);
174
0
  if (!ne) {
175
0
    return 0;
176
0
  }
177
0
  int ret = X509_NAME_add_entry(name, ne, loc, set);
178
0
  X509_NAME_ENTRY_free(ne);
179
0
  return ret;
180
0
}
181
182
int X509_NAME_add_entry_by_txt(X509_NAME *name, const char *field, int type,
183
                               const unsigned char *bytes, ossl_ssize_t len,
184
0
                               int loc, int set) {
185
0
  X509_NAME_ENTRY *ne =
186
0
      X509_NAME_ENTRY_create_by_txt(NULL, field, type, bytes, len);
187
0
  if (!ne) {
188
0
    return 0;
189
0
  }
190
0
  int ret = X509_NAME_add_entry(name, ne, loc, set);
191
0
  X509_NAME_ENTRY_free(ne);
192
0
  return ret;
193
0
}
194
195
// if set is -1, append to previous set, 0 'a new one', and 1, prepend to the
196
// guy we are about to stomp on.
197
int X509_NAME_add_entry(X509_NAME *name, const X509_NAME_ENTRY *entry, int loc,
198
0
                        int set) {
199
0
  X509_NAME_ENTRY *new_name = NULL;
200
0
  int i, inc;
201
0
  STACK_OF(X509_NAME_ENTRY) *sk;
202
203
0
  if (name == NULL) {
204
0
    return 0;
205
0
  }
206
0
  sk = name->entries;
207
0
  int n = (int)sk_X509_NAME_ENTRY_num(sk);
208
0
  if (loc > n) {
209
0
    loc = n;
210
0
  } else if (loc < 0) {
211
0
    loc = n;
212
0
  }
213
214
0
  inc = (set == 0);
215
0
  name->modified = 1;
216
217
0
  if (set == -1) {
218
0
    if (loc == 0) {
219
0
      set = 0;
220
0
      inc = 1;
221
0
    } else {
222
0
      set = sk_X509_NAME_ENTRY_value(sk, loc - 1)->set;
223
0
    }
224
0
  } else {  // if (set >= 0)
225
226
0
    if (loc >= n) {
227
0
      if (loc != 0) {
228
0
        set = sk_X509_NAME_ENTRY_value(sk, loc - 1)->set + 1;
229
0
      } else {
230
0
        set = 0;
231
0
      }
232
0
    } else {
233
0
      set = sk_X509_NAME_ENTRY_value(sk, loc)->set;
234
0
    }
235
0
  }
236
237
0
  if ((new_name = X509_NAME_ENTRY_dup(entry)) == NULL) {
238
0
    goto err;
239
0
  }
240
0
  new_name->set = set;
241
0
  if (!sk_X509_NAME_ENTRY_insert(sk, new_name, loc)) {
242
0
    goto err;
243
0
  }
244
0
  if (inc) {
245
0
    n = (int)sk_X509_NAME_ENTRY_num(sk);
246
0
    for (i = loc + 1; i < n; i++) {
247
0
      sk_X509_NAME_ENTRY_value(sk, i)->set += 1;
248
0
    }
249
0
  }
250
0
  return 1;
251
0
err:
252
0
  if (new_name != NULL) {
253
0
    X509_NAME_ENTRY_free(new_name);
254
0
  }
255
0
  return 0;
256
0
}
257
258
X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_txt(X509_NAME_ENTRY **ne,
259
                                               const char *field, int type,
260
                                               const unsigned char *bytes,
261
0
                                               ossl_ssize_t len) {
262
0
  ASN1_OBJECT *obj;
263
0
  X509_NAME_ENTRY *nentry;
264
265
0
  obj = OBJ_txt2obj(field, 0);
266
0
  if (obj == NULL) {
267
0
    OPENSSL_PUT_ERROR(X509, X509_R_INVALID_FIELD_NAME);
268
0
    ERR_add_error_data(2, "name=", field);
269
0
    return NULL;
270
0
  }
271
0
  nentry = X509_NAME_ENTRY_create_by_OBJ(ne, obj, type, bytes, len);
272
0
  ASN1_OBJECT_free(obj);
273
0
  return nentry;
274
0
}
275
276
X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_NID(X509_NAME_ENTRY **ne, int nid,
277
                                               int type,
278
                                               const unsigned char *bytes,
279
0
                                               ossl_ssize_t len) {
280
0
  const ASN1_OBJECT *obj = OBJ_nid2obj(nid);
281
0
  if (obj == NULL) {
282
0
    OPENSSL_PUT_ERROR(X509, X509_R_UNKNOWN_NID);
283
0
    return NULL;
284
0
  }
285
0
  return X509_NAME_ENTRY_create_by_OBJ(ne, obj, type, bytes, len);
286
0
}
287
288
X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_OBJ(X509_NAME_ENTRY **ne,
289
                                               const ASN1_OBJECT *obj, int type,
290
                                               const unsigned char *bytes,
291
0
                                               ossl_ssize_t len) {
292
0
  X509_NAME_ENTRY *ret;
293
294
0
  if ((ne == NULL) || (*ne == NULL)) {
295
0
    if ((ret = X509_NAME_ENTRY_new()) == NULL) {
296
0
      return NULL;
297
0
    }
298
0
  } else {
299
0
    ret = *ne;
300
0
  }
301
302
0
  if (!X509_NAME_ENTRY_set_object(ret, obj)) {
303
0
    goto err;
304
0
  }
305
0
  if (!X509_NAME_ENTRY_set_data(ret, type, bytes, len)) {
306
0
    goto err;
307
0
  }
308
309
0
  if ((ne != NULL) && (*ne == NULL)) {
310
0
    *ne = ret;
311
0
  }
312
0
  return ret;
313
0
err:
314
0
  if ((ne == NULL) || (ret != *ne)) {
315
0
    X509_NAME_ENTRY_free(ret);
316
0
  }
317
0
  return NULL;
318
0
}
319
320
0
int X509_NAME_ENTRY_set_object(X509_NAME_ENTRY *ne, const ASN1_OBJECT *obj) {
321
0
  if ((ne == NULL) || (obj == NULL)) {
322
0
    OPENSSL_PUT_ERROR(X509, ERR_R_PASSED_NULL_PARAMETER);
323
0
    return 0;
324
0
  }
325
0
  ASN1_OBJECT_free(ne->object);
326
0
  ne->object = OBJ_dup(obj);
327
0
  return ((ne->object == NULL) ? 0 : 1);
328
0
}
329
330
int X509_NAME_ENTRY_set_data(X509_NAME_ENTRY *ne, int type,
331
0
                             const unsigned char *bytes, ossl_ssize_t len) {
332
0
  if ((ne == NULL) || ((bytes == NULL) && (len != 0))) {
333
0
    return 0;
334
0
  }
335
0
  if ((type > 0) && (type & MBSTRING_FLAG)) {
336
0
    return ASN1_STRING_set_by_NID(&ne->value, bytes, len, type,
337
0
                                  OBJ_obj2nid(ne->object))
338
0
               ? 1
339
0
               : 0;
340
0
  }
341
0
  if (len < 0) {
342
0
    len = strlen((const char *)bytes);
343
0
  }
344
0
  if (!ASN1_STRING_set(ne->value, bytes, len)) {
345
0
    return 0;
346
0
  }
347
0
  if (type != V_ASN1_UNDEF) {
348
0
    ne->value->type = type;
349
0
  }
350
0
  return 1;
351
0
}
352
353
1.18k
ASN1_OBJECT *X509_NAME_ENTRY_get_object(const X509_NAME_ENTRY *ne) {
354
1.18k
  if (ne == NULL) {
355
0
    return NULL;
356
0
  }
357
1.18k
  return ne->object;
358
1.18k
}
359
360
1.18k
ASN1_STRING *X509_NAME_ENTRY_get_data(const X509_NAME_ENTRY *ne) {
361
1.18k
  if (ne == NULL) {
362
0
    return NULL;
363
0
  }
364
1.18k
  return ne->value;
365
1.18k
}