summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ASN1_STRING_TABLE_get.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/ASN1_STRING_TABLE_get.3')
-rw-r--r--src/lib/libcrypto/man/ASN1_STRING_TABLE_get.394
1 files changed, 0 insertions, 94 deletions
diff --git a/src/lib/libcrypto/man/ASN1_STRING_TABLE_get.3 b/src/lib/libcrypto/man/ASN1_STRING_TABLE_get.3
deleted file mode 100644
index 2bf8831c12..0000000000
--- a/src/lib/libcrypto/man/ASN1_STRING_TABLE_get.3
+++ /dev/null
@@ -1,94 +0,0 @@
1.\" $OpenBSD: ASN1_STRING_TABLE_get.3,v 1.4 2023/12/21 21:23:37 tb Exp $
2.\" checked up to:
3.\" OpenSSL ASN1_STRING_TABLE_add.pod 7b608d08 Jul 27 01:18:50 2017 +0800
4.\"
5.\" Copyright (c) 2017, 2021 Ingo Schwarze <schwarze@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd $Mdocdate: December 21 2023 $
20.Dt ASN1_STRING_TABLE_GET 3
21.Os
22.Sh NAME
23.\" .Nm ASN1_STRING_TABLE_add0 and
24.\" .Nm ASN1_STRING_TABLE_cleanup are intentionally undocumented
25.\" because they will be removed in the next major bump
26.\" .Dv STABLE_FLAGS_MALLOC is intentionally undocumented because it is unused
27.Nm ASN1_STRING_TABLE_get
28.Nd retrieve an entry from the global ASN.1 string table
29.Sh SYNOPSIS
30.In openssl/asn1.h
31.Ft ASN1_STRING_TABLE *
32.Fo ASN1_STRING_TABLE_get
33.Fa "int nid"
34.Fc
35.Sh DESCRIPTION
36The ASN.1 string table is a unique global object.
37Each entry is of the type
38.Vt ASN1_STRING_TABLE
39and contains information about one NID object.
40The entries are predefined according to RFC 5280 appendix A.1.
41.Pp
42The upper bounds for the number of characters in various kinds of
43.Vt ASN1_STRING
44objects are:
45.Pp
46.Bl -column -compact NID_organizationalUnitNa maxsi ub_organization_unit_na
47.It object type Ta maxsize Ta symbolic constant
48.It Dv NID_commonName Ta 64 Ta Dv ub_common_name
49.It Dv NID_countryName Ta 2 Ta \(em
50.It Dv NID_givenName Ta 32768 Ta Dv ub_name
51.It Dv NID_initials Ta 32768 Ta Dv ub_name
52.It Dv NID_localityName Ta 128 Ta Dv ub_locality_name
53.It Dv NID_name Ta 32768 Ta Dv ub_name
54.It Dv NID_organizationName Ta 64 Ta Dv ub_organization_name
55.It Dv NID_organizationalUnitName Ta 64 Ta Dv ub_organization_unit_name
56.It Dv NID_pkcs9_emailAddress Ta 128 Ta Dv ub_email_address
57.It Dv NID_serialNumber Ta 64 Ta Dv ub_serial_number
58.It Dv NID_stateOrProvinceName Ta 128 Ta Dv ub_state_name
59.It Dv NID_surname Ta 32768 Ta Dv ub_name
60.El
61.Pp
62The function
63.Fn ASN1_STRING_TABLE_get
64retrieves the entry for
65.Fa nid .
66If the
67.Dv STABLE_NO_MASK
68flag is set,
69.Xr ASN1_STRING_set_by_NID 3
70skips applying the global mask that can be set with
71.Xr ASN1_STRING_set_default_mask 3 .
72.Sh RETURN VALUES
73.Fn ASN1_STRING_TABLE_get
74returns a valid
75.Vt ASN1_STRING_TABLE
76structure or
77.Dv NULL
78if nothing is found.
79.Sh SEE ALSO
80.Xr ASN1_OBJECT_new 3 ,
81.Xr ASN1_STRING_set_by_NID 3 ,
82.Xr OBJ_create 3 ,
83.Xr OBJ_nid2obj 3
84.Sh HISTORY
85.Fn ASN1_STRING_TABLE_get
86first appeared in OpenSSL 0.9.5 and has been available since
87.Ox 2.7 .
88.Sh BUGS
89Most aspects of the semantics considerably differ from OpenSSL.
90.Pp
91.Dv ub_email_address ,
92which should really be called
93.Dv ub_emailaddress_length ,
94was changed in RFC 5280 from 128 to 255 to match PKCS#9 (RFC 2985).