Debian Codegraph @

upstream/debian-unstable/man3/ASN1_STRING_TABLE_add.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "ASN1_STRING_TABLE_ADD 3SSL"
58 .TH ASN1_STRING_TABLE_ADD 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ASN1_STRING_TABLE, ASN1_STRING_TABLE_add, ASN1_STRING_TABLE_get,
65 ASN1_STRING_TABLE_cleanup \- ASN1_STRING_TABLE manipulation functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/asn1.h>
70 \&
71 \& typedef struct asn1_string_table_st ASN1_STRING_TABLE;
72 \&
73 \& int ASN1_STRING_TABLE_add(int nid, long minsize, long maxsize,
74 \& unsigned long mask, unsigned long flags);
75 \& ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid);
76 \& void ASN1_STRING_TABLE_cleanup(void);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 .SS Types
81 .IX Subsection "Types"
82 \&\fBASN1_STRING_TABLE\fR is a table which holds string information
83 (basically minimum size, maximum size, type and etc) for a NID object.
84 .SS Functions
85 .IX Subsection "Functions"
86 \&\fBASN1_STRING_TABLE_add()\fR adds a new \fBASN1_STRING_TABLE\fR item into the
87 local ASN1 string table based on the \fInid\fR along with other parameters.
88 .PP
89 If the item is already in the table, fields of \fBASN1_STRING_TABLE\fR are
90 updated (depending on the values of those parameters, e.g., \fIminsize\fR
91 and \fImaxsize\fR >= 0, \fImask\fR and \fIflags\fR != 0). If the \fInid\fR is standard,
92 a copy of the standard \fBASN1_STRING_TABLE\fR is created and updated with
93 other parameters.
94 .PP
95 \&\fBASN1_STRING_TABLE_get()\fR searches for an \fBASN1_STRING_TABLE\fR item based
96 on \fInid\fR. It will search the local table first, then the standard one.
97 .PP
98 \&\fBASN1_STRING_TABLE_cleanup()\fR frees all \fBASN1_STRING_TABLE\fR items added
99 by \fBASN1_STRING_TABLE_add()\fR.
100 .SH "RETURN VALUES"
101 .IX Header "RETURN VALUES"
102 \&\fBASN1_STRING_TABLE_add()\fR returns 1 on success, 0 if an error occurred.
103 .PP
104 \&\fBASN1_STRING_TABLE_get()\fR returns a valid \fBASN1_STRING_TABLE\fR structure
105 or NULL if nothing is found.
106 .PP
107 \&\fBASN1_STRING_TABLE_cleanup()\fR does not return a value.
108 .SH "SEE ALSO"
109 .IX Header "SEE ALSO"
110 \&\fBERR_get_error\fR\|(3)
111 .SH COPYRIGHT
112 .IX Header "COPYRIGHT"
113 Copyright 2017\-2020 The OpenSSL Project Authors. All Rights Reserved.
114 .PP
115 Licensed under the Apache License 2.0 (the "License"). You may not use
116 this file except in compliance with the License. You can obtain a copy
117 in the file LICENSE in the source distribution or at
118 <https://www.openssl.org/source/license.html>.