xref: /openssl/doc/man3/ADMISSIONS.pod (revision c2969ff6)
1=pod
2
3=head1 NAME
4
5ADMISSIONS,
6ADMISSIONS_get0_admissionAuthority,
7ADMISSIONS_get0_namingAuthority,
8ADMISSIONS_get0_professionInfos,
9ADMISSIONS_set0_admissionAuthority,
10ADMISSIONS_set0_namingAuthority,
11ADMISSIONS_set0_professionInfos,
12ADMISSION_SYNTAX,
13ADMISSION_SYNTAX_get0_admissionAuthority,
14ADMISSION_SYNTAX_get0_contentsOfAdmissions,
15ADMISSION_SYNTAX_set0_admissionAuthority,
16ADMISSION_SYNTAX_set0_contentsOfAdmissions,
17NAMING_AUTHORITY,
18NAMING_AUTHORITY_get0_authorityId,
19NAMING_AUTHORITY_get0_authorityURL,
20NAMING_AUTHORITY_get0_authorityText,
21NAMING_AUTHORITY_set0_authorityId,
22NAMING_AUTHORITY_set0_authorityURL,
23NAMING_AUTHORITY_set0_authorityText,
24PROFESSION_INFO,
25PROFESSION_INFOS,
26PROFESSION_INFO_get0_addProfessionInfo,
27PROFESSION_INFO_get0_namingAuthority,
28PROFESSION_INFO_get0_professionItems,
29PROFESSION_INFO_get0_professionOIDs,
30PROFESSION_INFO_get0_registrationNumber,
31PROFESSION_INFO_set0_addProfessionInfo,
32PROFESSION_INFO_set0_namingAuthority,
33PROFESSION_INFO_set0_professionItems,
34PROFESSION_INFO_set0_professionOIDs,
35PROFESSION_INFO_set0_registrationNumber
36- Accessors and settors for ADMISSION_SYNTAX
37
38=head1 SYNOPSIS
39
40 typedef struct NamingAuthority_st NAMING_AUTHORITY;
41 typedef struct ProfessionInfo_st PROFESSION_INFO;
42 typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS;
43 typedef struct Admissions_st ADMISSIONS;
44 typedef struct AdmissionSyntax_st ADMISSION_SYNTAX;
45
46 const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId(
47     const NAMING_AUTHORITY *n);
48 void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n,
49     ASN1_OBJECT* namingAuthorityId);
50 const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL(
51     const NAMING_AUTHORITY *n);
52 void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n,
53     ASN1_IA5STRING* namingAuthorityUrl);
54 const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText(
55     const NAMING_AUTHORITY *n);
56 void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n,
57     ASN1_STRING* namingAuthorityText);
58
59 const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority(
60     const ADMISSION_SYNTAX *as);
61 void ADMISSION_SYNTAX_set0_admissionAuthority(
62     ADMISSION_SYNTAX *as, GENERAL_NAME *aa);
63 const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions(
64     const ADMISSION_SYNTAX *as);
65 void ADMISSION_SYNTAX_set0_contentsOfAdmissions(
66     ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a);
67
68 const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a);
69 void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa);
70 const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a);
71 void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na);
72 const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a);
73 void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi);
74
75 const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo(
76     const PROFESSION_INFO *pi);
77 void PROFESSION_INFO_set0_addProfessionInfo(
78     PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos);
79 const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority(
80     const PROFESSION_INFO *pi);
81 void PROFESSION_INFO_set0_namingAuthority(
82     PROFESSION_INFO *pi, NAMING_AUTHORITY *na);
83 const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems(
84     const PROFESSION_INFO *pi);
85 void PROFESSION_INFO_set0_professionItems(
86     PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as);
87 const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs(
88     const PROFESSION_INFO *pi);
89 void PROFESSION_INFO_set0_professionOIDs(
90     PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po);
91 const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber(
92     const PROFESSION_INFO *pi);
93 void PROFESSION_INFO_set0_registrationNumber(
94     PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn);
95
96=head1 DESCRIPTION
97
98The B<PROFESSION_INFOS>, B<ADMISSION_SYNTAX>, B<ADMISSIONS>, and
99B<PROFESSION_INFO> types are opaque structures representing the
100analogous types defined in the Common PKI Specification published
101by L<https://www.t7ev.org>.
102Knowledge of those structures and their semantics is assumed.
103
104The conventional routines to convert between DER and the local format
105are described in L<d2i_X509(3)>.
106The conventional routines to allocate and free the types are defined
107in L<X509_dup(3)>.
108
109The B<PROFESSION_INFOS> type is a stack of B<PROFESSION_INFO>; see
110L<DEFINE_STACK_OF(3)> for details.
111
112The B<NAMING_AUTHORITY> type has an authority ID and URL, and text fields.
113The NAMING_AUTHORITY_get0_authorityId(),
114NAMING_AUTHORITY_get0_get0_authorityURL(), and
115NAMING_AUTHORITY_get0_get0_authorityText(), functions return pointers
116to those values within the object.
117The NAMING_AUTHORITY_set0_authorityId(),
118NAMING_AUTHORITY_set0_get0_authorityURL(), and
119NAMING_AUTHORITY_set0_get0_authorityText(),
120functions free any existing value and set the pointer to the specified value.
121
122The B<ADMISSION_SYNTAX> type has an authority name and a stack of
123B<ADMISSION> objects.
124The ADMISSION_SYNTAX_get0_admissionAuthority()
125and ADMISSION_SYNTAX_get0_contentsOfAdmissions() functions return pointers
126to those values within the object.
127The
128ADMISSION_SYNTAX_set0_admissionAuthority() and
129ADMISSION_SYNTAX_set0_contentsOfAdmissions()
130functions free any existing value and set the pointer to the specified value.
131
132The B<ADMISSION> type has an authority name, authority object, and a
133stack of B<PROFESSION_INFO> items.
134The ADMISSIONS_get0_admissionAuthority(), ADMISSIONS_get0_namingAuthority(),
135and ADMISSIONS_get0_professionInfos()
136functions return pointers to those values within the object.
137The
138ADMISSIONS_set0_admissionAuthority(),
139ADMISSIONS_set0_namingAuthority(), and
140ADMISSIONS_set0_professionInfos()
141functions free any existing value and set the pointer to the specified value.
142
143The B<PROFESSION_INFO> type has a name authority, stacks of
144profession Items and OIDs, a registration number, and additional
145profession info.
146The functions PROFESSION_INFO_get0_addProfessionInfo(),
147PROFESSION_INFO_get0_namingAuthority(), PROFESSION_INFO_get0_professionItems(),
148PROFESSION_INFO_get0_professionOIDs(), and
149PROFESSION_INFO_get0_registrationNumber()
150functions return pointers to those values within the object.
151The
152PROFESSION_INFO_set0_addProfessionInfo(),
153PROFESSION_INFO_set0_namingAuthority(),
154PROFESSION_INFO_set0_professionItems(),
155PROFESSION_INFO_set0_professionOIDs(), and
156PROFESSION_INFO_set0_registrationNumber()
157functions free any existing value and set the pointer to the specified value.
158
159=head1 RETURN VALUES
160
161Described above.
162Note that all of the I<get0> functions return a pointer to the internal data
163structure and must not be freed.
164
165=head1 SEE ALSO
166
167L<X509_dup(3)>,
168L<d2i_X509(3)>,
169
170=head1 COPYRIGHT
171
172Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
173
174Licensed under the Apache License 2.0 (the "License").  You may not use
175this file except in compliance with the License.  You can obtain a copy
176in the file LICENSE in the source distribution or at
177L<https://www.openssl.org/source/license.html>.
178
179=cut
180