secure/lib/libcrypto/man/ADMISSIONS.3

   1 .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "ADMISSIONS 3"
 136 .TH ADMISSIONS 3 "2019-02-26" "1.1.1b" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 ADMISSIONS, ADMISSIONS_get0_admissionAuthority, ADMISSIONS_get0_namingAuthority, ADMISSIONS_get0_professionInfos, ADMISSIONS_set0_admissionAuthority, ADMISSIONS_set0_namingAuthority, ADMISSIONS_set0_professionInfos, ADMISSION_SYNTAX, ADMISSION_SYNTAX_get0_admissionAuthority, ADMISSION_SYNTAX_get0_contentsOfAdmissions, ADMISSION_SYNTAX_set0_admissionAuthority, ADMISSION_SYNTAX_set0_contentsOfAdmissions, NAMING_AUTHORITY, NAMING_AUTHORITY_get0_authorityId, NAMING_AUTHORITY_get0_authorityURL, NAMING_AUTHORITY_get0_authorityText, NAMING_AUTHORITY_set0_authorityId, NAMING_AUTHORITY_set0_authorityURL, NAMING_AUTHORITY_set0_authorityText, PROFESSION_INFO, PROFESSION_INFOS, PROFESSION_INFO_get0_addProfessionInfo, PROFESSION_INFO_get0_namingAuthority, PROFESSION_INFO_get0_professionItems, PROFESSION_INFO_get0_professionOIDs, PROFESSION_INFO_get0_registrationNumber, PROFESSION_INFO_set0_addProfessionInfo, PROFESSION_INFO_set0_namingAuthority, PROFESSION_INFO_set0_professionItems, PROFESSION_INFO_set0_professionOIDs, PROFESSION_INFO_set0_registrationNumber \&\- Accessors and settors for ADMISSION_SYNTAX
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 5
 146 \& typedef struct NamingAuthority_st NAMING_AUTHORITY;
 147 \& typedef struct ProfessionInfo_st PROFESSION_INFO;
 148 \& typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS;
 149 \& typedef struct Admissions_st ADMISSIONS;
 150 \& typedef struct AdmissionSyntax_st ADMISSION_SYNTAX;
 151 \&
 152 \& const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId(
 153 \&     const NAMING_AUTHORITY *n);
 154 \& void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n,
 155 \&     ASN1_OBJECT* namingAuthorityId);
 156 \& const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL(
 157 \&     const NAMING_AUTHORITY *n);
 158 \& void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n,
 159 \&     ASN1_IA5STRING* namingAuthorityUrl);
 160 \& const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText(
 161 \&     const NAMING_AUTHORITY *n);
 162 \& void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n,
 163 \&     ASN1_STRING* namingAuthorityText);
 164 \&
 165 \& const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority(
 166 \&     const ADMISSION_SYNTAX *as);
 167 \& void ADMISSION_SYNTAX_set0_admissionAuthority(
 168 \&     ADMISSION_SYNTAX *as, GENERAL_NAME *aa);
 169 \& const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions(
 170 \&     const ADMISSION_SYNTAX *as);
 171 \& void ADMISSION_SYNTAX_set0_contentsOfAdmissions(
 172 \&     ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a);
 173 \&
 174 \& const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a);
 175 \& void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa);
 176 \& const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a);
 177 \& void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na);
 178 \& const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a);
 179 \& void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi);
 180 \&
 181 \& const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo(
 182 \&     const PROFESSION_INFO *pi);
 183 \& void PROFESSION_INFO_set0_addProfessionInfo(
 184 \&     PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos);
 185 \& const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority(
 186 \&     const PROFESSION_INFO *pi);
 187 \& void PROFESSION_INFO_set0_namingAuthority(
 188 \&     PROFESSION_INFO *pi, NAMING_AUTHORITY *na);
 189 \& const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems(
 190 \&     const PROFESSION_INFO *pi);
 191 \& void PROFESSION_INFO_set0_professionItems(
 192 \&     PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as);
 193 \& const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs(
 194 \&     const PROFESSION_INFO *pi);
 195 \& void PROFESSION_INFO_set0_professionOIDs(
 196 \&     PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po);
 197 \& const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber(
 198 \&     const PROFESSION_INFO *pi);
 199 \& void PROFESSION_INFO_set0_registrationNumber(
 200 \&     PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn);
 201 .Ve
 202 .SH "DESCRIPTION"
 203 .IX Header "DESCRIPTION"
 204 The \fB\s-1PROFESSION_INFOS\s0\fR, \fB\s-1ADMISSION_SYNTAX\s0\fR, \fB\s-1ADMISSIONS\s0\fR, and
 205 \&\fB\s-1PROFESSION_INFO\s0\fR types are opaque structures representing the
 206 analogous types defined in the Common \s-1PKI\s0 Specification published
 207 by <https://www.t7ev.org>.
 208 Knowledge of those structures and their semantics is assumed.
 209 .PP
 210 The conventional routines to convert between \s-1DER\s0 and the local format
 211 are described in \fBd2i_X509\fR\|(3).
 212 The conventional routines to allocate and free the types are defined
 213 in \fBX509_dup\fR\|(3).
 214 .PP
 215 The \fB\s-1PROFESSION_INFOS\s0\fR type is a stack of \fB\s-1PROFESSION_INFO\s0\fR; see
 216 \&\s-1\fBDEFINE_STACK_OF\s0\fR\|(3) for details.
 217 .PP
 218 The \fB\s-1NAMING_AUTHORITY\s0\fR type has an authority \s-1ID\s0 and \s-1URL,\s0 and text fields.
 219 The \fBNAMING_AUTHORITY_get0_authorityId()\fR,
 220 \&\fBNAMING_AUTHORITY_get0_get0_authorityURL()\fR, and
 221 \&\fBNAMING_AUTHORITY_get0_get0_authorityText()\fR, functions return pointers
 222 to those values within the object.
 223 The \fBNAMING_AUTHORITY_set0_authorityId()\fR,
 224 \&\fBNAMING_AUTHORITY_set0_get0_authorityURL()\fR, and
 225 \&\fBNAMING_AUTHORITY_set0_get0_authorityText()\fR,
 226 functions free any existing value and set the pointer to the specified value.
 227 .PP
 228 The \fB\s-1ADMISSION_SYNTAX\s0\fR type has an authority name and a stack of
 229 \&\fB\s-1ADMISSION\s0\fR objects.
 230 The \fBADMISSION_SYNTAX_get0_admissionAuthority()\fR
 231 and \fBADMISSION_SYNTAX_get0_contentsOfAdmissions()\fR functions return pointers
 232 to those values within the object.
 233 The
 234 \&\fBADMISSION_SYNTAX_set0_admissionAuthority()\fR and
 235 \&\fBADMISSION_SYNTAX_set0_contentsOfAdmissions()\fR
 236 functions free any existing value and set the pointer to the specified value.
 237 .PP
 238 The \fB\s-1ADMISSION\s0\fR type has an authority name, authority object, and a
 239 stack of \fB\s-1PROFSSION_INFO\s0\fR items.
 240 The \fBADMISSIONS_get0_admissionAuthority()\fR, \fBADMISSIONS_get0_namingAuthority()\fR,
 241 and \fBADMISSIONS_get0_professionInfos()\fR
 242 functions return pointers to those values within the object.
 243 The
 244 \&\fBADMISSIONS_set0_admissionAuthority()\fR,
 245 \&\fBADMISSIONS_set0_namingAuthority()\fR, and
 246 \&\fBADMISSIONS_set0_professionInfos()\fR
 247 functions free any existing value and set the pointer to the specified value.
 248 .PP
 249 The \fB\s-1PROFESSION_INFO\s0\fR type has a name authority, stacks of
 250 profession Items and OIDs, a registration number, and additional
 251 profession info.
 252 The functions \fBPROFESSION_INFO_get0_addProfessionInfo()\fR,
 253 \&\fBPROFESSION_INFO_get0_namingAuthority()\fR, \fBPROFESSION_INFO_get0_professionItems()\fR,
 254 \&\fBPROFESSION_INFO_get0_professionOIDs()\fR, and
 255 \&\fBPROFESSION_INFO_get0_registrationNumber()\fR
 256 functions return pointers to those values within the object.
 257 The
 258 \&\fBPROFESSION_INFO_set0_addProfessionInfo()\fR,
 259 \&\fBPROFESSION_INFO_set0_namingAuthority()\fR,
 260 \&\fBPROFESSION_INFO_set0_professionItems()\fR,
 261 \&\fBPROFESSION_INFO_set0_professionOIDs()\fR, and
 262 \&\fBPROFESSION_INFO_set0_registrationNumber()\fR
 263 functions free any existing value and set the pointer to the specified value.
 264 .SH "RETURN VALUES"
 265 .IX Header "RETURN VALUES"
 266 Described above.
 267 Note that all of the \fIget0\fR functions return a pointer to the internal data
 268 structure and must not be freed.
 269 .SH "SEE ALSO"
 270 .IX Header "SEE ALSO"
 271 \&\fBX509_dup\fR\|(3),
 272 \&\fBd2i_X509\fR\|(3),
 273 .SH "COPYRIGHT"
 274 .IX Header "COPYRIGHT"
 275 Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
 276 .PP
 277 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 278 this file except in compliance with the License.  You can obtain a copy
 279 in the file \s-1LICENSE\s0 in the source distribution or at
 280 <https://www.openssl.org/source/license.html>.