Debian Codegraph @

upstream/debian-unstable/man3/ADMISSIONS.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 "ADMISSIONS 3SSL"
58 .TH ADMISSIONS 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 ADMISSIONS,
65 ADMISSIONS_get0_admissionAuthority,
66 ADMISSIONS_get0_namingAuthority,
67 ADMISSIONS_get0_professionInfos,
68 ADMISSIONS_set0_admissionAuthority,
69 ADMISSIONS_set0_namingAuthority,
70 ADMISSIONS_set0_professionInfos,
71 ADMISSION_SYNTAX,
72 ADMISSION_SYNTAX_get0_admissionAuthority,
73 ADMISSION_SYNTAX_get0_contentsOfAdmissions,
74 ADMISSION_SYNTAX_set0_admissionAuthority,
75 ADMISSION_SYNTAX_set0_contentsOfAdmissions,
76 NAMING_AUTHORITY,
77 NAMING_AUTHORITY_get0_authorityId,
78 NAMING_AUTHORITY_get0_authorityURL,
79 NAMING_AUTHORITY_get0_authorityText,
80 NAMING_AUTHORITY_set0_authorityId,
81 NAMING_AUTHORITY_set0_authorityURL,
82 NAMING_AUTHORITY_set0_authorityText,
83 PROFESSION_INFO,
84 PROFESSION_INFOS,
85 PROFESSION_INFO_get0_addProfessionInfo,
86 PROFESSION_INFO_get0_namingAuthority,
87 PROFESSION_INFO_get0_professionItems,
88 PROFESSION_INFO_get0_professionOIDs,
89 PROFESSION_INFO_get0_registrationNumber,
90 PROFESSION_INFO_set0_addProfessionInfo,
91 PROFESSION_INFO_set0_namingAuthority,
92 PROFESSION_INFO_set0_professionItems,
93 PROFESSION_INFO_set0_professionOIDs,
94 PROFESSION_INFO_set0_registrationNumber
95 \&\- Accessors and settors for ADMISSION_SYNTAX
96 .SH SYNOPSIS
97 .IX Header "SYNOPSIS"
98 .Vb 5
99 \& typedef struct NamingAuthority_st NAMING_AUTHORITY;
100 \& typedef struct ProfessionInfo_st PROFESSION_INFO;
101 \& typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS;
102 \& typedef struct Admissions_st ADMISSIONS;
103 \& typedef struct AdmissionSyntax_st ADMISSION_SYNTAX;
104 \&
105 \& const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId(
106 \& const NAMING_AUTHORITY *n);
107 \& void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n,
108 \& ASN1_OBJECT* namingAuthorityId);
109 \& const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL(
110 \& const NAMING_AUTHORITY *n);
111 \& void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n,
112 \& ASN1_IA5STRING* namingAuthorityUrl);
113 \& const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText(
114 \& const NAMING_AUTHORITY *n);
115 \& void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n,
116 \& ASN1_STRING* namingAuthorityText);
117 \&
118 \& const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority(
119 \& const ADMISSION_SYNTAX *as);
120 \& void ADMISSION_SYNTAX_set0_admissionAuthority(
121 \& ADMISSION_SYNTAX *as, GENERAL_NAME *aa);
122 \& const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions(
123 \& const ADMISSION_SYNTAX *as);
124 \& void ADMISSION_SYNTAX_set0_contentsOfAdmissions(
125 \& ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a);
126 \&
127 \& const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a);
128 \& void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa);
129 \& const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a);
130 \& void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na);
131 \& const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a);
132 \& void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi);
133 \&
134 \& const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo(
135 \& const PROFESSION_INFO *pi);
136 \& void PROFESSION_INFO_set0_addProfessionInfo(
137 \& PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos);
138 \& const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority(
139 \& const PROFESSION_INFO *pi);
140 \& void PROFESSION_INFO_set0_namingAuthority(
141 \& PROFESSION_INFO *pi, NAMING_AUTHORITY *na);
142 \& const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems(
143 \& const PROFESSION_INFO *pi);
144 \& void PROFESSION_INFO_set0_professionItems(
145 \& PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as);
146 \& const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs(
147 \& const PROFESSION_INFO *pi);
148 \& void PROFESSION_INFO_set0_professionOIDs(
149 \& PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po);
150 \& const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber(
151 \& const PROFESSION_INFO *pi);
152 \& void PROFESSION_INFO_set0_registrationNumber(
153 \& PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn);
154 .Ve
155 .SH DESCRIPTION
156 .IX Header "DESCRIPTION"
157 The \fBPROFESSION_INFOS\fR, \fBADMISSION_SYNTAX\fR, \fBADMISSIONS\fR, and
158 \&\fBPROFESSION_INFO\fR types are opaque structures representing the
159 analogous types defined in the Common PKI Specification published
160 by T7 & TELETRUST <https://www.bundesnetzagentur.de/EVD/DE/SharedDocuments/Downloads/Anbieter_Infothek/Common_PKI_v2.0_02.pdf?__blob=publicationFile&v=1>.
161 Knowledge of those structures and their semantics is assumed.
162 .PP
163 The conventional routines to convert between DER and the local format
164 are described in \fBd2i_X509\fR\|(3).
165 The conventional routines to allocate and free the types are defined
166 in \fBX509_dup\fR\|(3).
167 .PP
168 The \fBPROFESSION_INFOS\fR type is a stack of \fBPROFESSION_INFO\fR; see
169 \&\fBDEFINE_STACK_OF\fR\|(3) for details.
170 .PP
171 The \fBNAMING_AUTHORITY\fR type has an authority ID and URL, and text fields.
172 The \fBNAMING_AUTHORITY_get0_authorityId()\fR,
173 \&\fBNAMING_AUTHORITY_get0_get0_authorityURL()\fR, and
174 \&\fBNAMING_AUTHORITY_get0_get0_authorityText()\fR, functions return pointers
175 to those values within the object.
176 The \fBNAMING_AUTHORITY_set0_authorityId()\fR,
177 \&\fBNAMING_AUTHORITY_set0_get0_authorityURL()\fR, and
178 \&\fBNAMING_AUTHORITY_set0_get0_authorityText()\fR,
179 functions free any existing value and set the pointer to the specified value.
180 .PP
181 The \fBADMISSION_SYNTAX\fR type has an authority name and a stack of
182 \&\fBADMISSION\fR objects.
183 The \fBADMISSION_SYNTAX_get0_admissionAuthority()\fR
184 and \fBADMISSION_SYNTAX_get0_contentsOfAdmissions()\fR functions return pointers
185 to those values within the object.
186 The
187 \&\fBADMISSION_SYNTAX_set0_admissionAuthority()\fR and
188 \&\fBADMISSION_SYNTAX_set0_contentsOfAdmissions()\fR
189 functions free any existing value and set the pointer to the specified value.
190 .PP
191 The \fBADMISSION\fR type has an authority name, authority object, and a
192 stack of \fBPROFESSION_INFO\fR items.
193 The \fBADMISSIONS_get0_admissionAuthority()\fR, \fBADMISSIONS_get0_namingAuthority()\fR,
194 and \fBADMISSIONS_get0_professionInfos()\fR
195 functions return pointers to those values within the object.
196 The
197 \&\fBADMISSIONS_set0_admissionAuthority()\fR,
198 \&\fBADMISSIONS_set0_namingAuthority()\fR, and
199 \&\fBADMISSIONS_set0_professionInfos()\fR
200 functions free any existing value and set the pointer to the specified value.
201 .PP
202 The \fBPROFESSION_INFO\fR type has a name authority, stacks of
203 profession Items and OIDs, a registration number, and additional
204 profession info.
205 The functions \fBPROFESSION_INFO_get0_addProfessionInfo()\fR,
206 \&\fBPROFESSION_INFO_get0_namingAuthority()\fR, \fBPROFESSION_INFO_get0_professionItems()\fR,
207 \&\fBPROFESSION_INFO_get0_professionOIDs()\fR, and
208 \&\fBPROFESSION_INFO_get0_registrationNumber()\fR
209 functions return pointers to those values within the object.
210 The
211 \&\fBPROFESSION_INFO_set0_addProfessionInfo()\fR,
212 \&\fBPROFESSION_INFO_set0_namingAuthority()\fR,
213 \&\fBPROFESSION_INFO_set0_professionItems()\fR,
214 \&\fBPROFESSION_INFO_set0_professionOIDs()\fR, and
215 \&\fBPROFESSION_INFO_set0_registrationNumber()\fR
216 functions free any existing value and set the pointer to the specified value.
217 .SH "RETURN VALUES"
218 .IX Header "RETURN VALUES"
219 Described above.
220 Note that all of the \fIget0\fR functions return a pointer to the internal data
221 structure and must not be freed.
222 .SH "SEE ALSO"
223 .IX Header "SEE ALSO"
224 \&\fBX509_dup\fR\|(3),
225 \&\fBd2i_X509\fR\|(3),
226 .SH COPYRIGHT
227 .IX Header "COPYRIGHT"
228 Copyright 2017\-2026 The OpenSSL Project Authors. All Rights Reserved.
229 .PP
230 Licensed under the Apache License 2.0 (the "License"). You may not use
231 this file except in compliance with the License. You can obtain a copy
232 in the file LICENSE in the source distribution or at
233 <https://www.openssl.org/source/license.html>.