ADMISSIONS.3ossl 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  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 3ossl"
  136. .TH ADMISSIONS 3ossl "2024-09-03" "3.3.2" "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,
  143. ADMISSIONS_get0_admissionAuthority,
  144. ADMISSIONS_get0_namingAuthority,
  145. ADMISSIONS_get0_professionInfos,
  146. ADMISSIONS_set0_admissionAuthority,
  147. ADMISSIONS_set0_namingAuthority,
  148. ADMISSIONS_set0_professionInfos,
  149. ADMISSION_SYNTAX,
  150. ADMISSION_SYNTAX_get0_admissionAuthority,
  151. ADMISSION_SYNTAX_get0_contentsOfAdmissions,
  152. ADMISSION_SYNTAX_set0_admissionAuthority,
  153. ADMISSION_SYNTAX_set0_contentsOfAdmissions,
  154. NAMING_AUTHORITY,
  155. NAMING_AUTHORITY_get0_authorityId,
  156. NAMING_AUTHORITY_get0_authorityURL,
  157. NAMING_AUTHORITY_get0_authorityText,
  158. NAMING_AUTHORITY_set0_authorityId,
  159. NAMING_AUTHORITY_set0_authorityURL,
  160. NAMING_AUTHORITY_set0_authorityText,
  161. PROFESSION_INFO,
  162. PROFESSION_INFOS,
  163. PROFESSION_INFO_get0_addProfessionInfo,
  164. PROFESSION_INFO_get0_namingAuthority,
  165. PROFESSION_INFO_get0_professionItems,
  166. PROFESSION_INFO_get0_professionOIDs,
  167. PROFESSION_INFO_get0_registrationNumber,
  168. PROFESSION_INFO_set0_addProfessionInfo,
  169. PROFESSION_INFO_set0_namingAuthority,
  170. PROFESSION_INFO_set0_professionItems,
  171. PROFESSION_INFO_set0_professionOIDs,
  172. PROFESSION_INFO_set0_registrationNumber
  173. \&\- Accessors and settors for ADMISSION_SYNTAX
  174. .SH "SYNOPSIS"
  175. .IX Header "SYNOPSIS"
  176. .Vb 5
  177. \& typedef struct NamingAuthority_st NAMING_AUTHORITY;
  178. \& typedef struct ProfessionInfo_st PROFESSION_INFO;
  179. \& typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS;
  180. \& typedef struct Admissions_st ADMISSIONS;
  181. \& typedef struct AdmissionSyntax_st ADMISSION_SYNTAX;
  182. \&
  183. \& const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId(
  184. \& const NAMING_AUTHORITY *n);
  185. \& void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n,
  186. \& ASN1_OBJECT* namingAuthorityId);
  187. \& const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL(
  188. \& const NAMING_AUTHORITY *n);
  189. \& void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n,
  190. \& ASN1_IA5STRING* namingAuthorityUrl);
  191. \& const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText(
  192. \& const NAMING_AUTHORITY *n);
  193. \& void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n,
  194. \& ASN1_STRING* namingAuthorityText);
  195. \&
  196. \& const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority(
  197. \& const ADMISSION_SYNTAX *as);
  198. \& void ADMISSION_SYNTAX_set0_admissionAuthority(
  199. \& ADMISSION_SYNTAX *as, GENERAL_NAME *aa);
  200. \& const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions(
  201. \& const ADMISSION_SYNTAX *as);
  202. \& void ADMISSION_SYNTAX_set0_contentsOfAdmissions(
  203. \& ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a);
  204. \&
  205. \& const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a);
  206. \& void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa);
  207. \& const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a);
  208. \& void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na);
  209. \& const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a);
  210. \& void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi);
  211. \&
  212. \& const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo(
  213. \& const PROFESSION_INFO *pi);
  214. \& void PROFESSION_INFO_set0_addProfessionInfo(
  215. \& PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos);
  216. \& const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority(
  217. \& const PROFESSION_INFO *pi);
  218. \& void PROFESSION_INFO_set0_namingAuthority(
  219. \& PROFESSION_INFO *pi, NAMING_AUTHORITY *na);
  220. \& const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems(
  221. \& const PROFESSION_INFO *pi);
  222. \& void PROFESSION_INFO_set0_professionItems(
  223. \& PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as);
  224. \& const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs(
  225. \& const PROFESSION_INFO *pi);
  226. \& void PROFESSION_INFO_set0_professionOIDs(
  227. \& PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po);
  228. \& const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber(
  229. \& const PROFESSION_INFO *pi);
  230. \& void PROFESSION_INFO_set0_registrationNumber(
  231. \& PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn);
  232. .Ve
  233. .SH "DESCRIPTION"
  234. .IX Header "DESCRIPTION"
  235. The \fB\s-1PROFESSION_INFOS\s0\fR, \fB\s-1ADMISSION_SYNTAX\s0\fR, \fB\s-1ADMISSIONS\s0\fR, and
  236. \&\fB\s-1PROFESSION_INFO\s0\fR types are opaque structures representing the
  237. analogous types defined in the Common \s-1PKI\s0 Specification published
  238. by <https://www.t7ev.org>.
  239. Knowledge of those structures and their semantics is assumed.
  240. .PP
  241. The conventional routines to convert between \s-1DER\s0 and the local format
  242. are described in \fBd2i_X509\fR\|(3).
  243. The conventional routines to allocate and free the types are defined
  244. in \fBX509_dup\fR\|(3).
  245. .PP
  246. The \fB\s-1PROFESSION_INFOS\s0\fR type is a stack of \fB\s-1PROFESSION_INFO\s0\fR; see
  247. \&\s-1\fBDEFINE_STACK_OF\s0\fR\|(3) for details.
  248. .PP
  249. The \fB\s-1NAMING_AUTHORITY\s0\fR type has an authority \s-1ID\s0 and \s-1URL,\s0 and text fields.
  250. The \fBNAMING_AUTHORITY_get0_authorityId()\fR,
  251. \&\fBNAMING_AUTHORITY_get0_get0_authorityURL()\fR, and
  252. \&\fBNAMING_AUTHORITY_get0_get0_authorityText()\fR, functions return pointers
  253. to those values within the object.
  254. The \fBNAMING_AUTHORITY_set0_authorityId()\fR,
  255. \&\fBNAMING_AUTHORITY_set0_get0_authorityURL()\fR, and
  256. \&\fBNAMING_AUTHORITY_set0_get0_authorityText()\fR,
  257. functions free any existing value and set the pointer to the specified value.
  258. .PP
  259. The \fB\s-1ADMISSION_SYNTAX\s0\fR type has an authority name and a stack of
  260. \&\fB\s-1ADMISSION\s0\fR objects.
  261. The \fBADMISSION_SYNTAX_get0_admissionAuthority()\fR
  262. and \fBADMISSION_SYNTAX_get0_contentsOfAdmissions()\fR functions return pointers
  263. to those values within the object.
  264. The
  265. \&\fBADMISSION_SYNTAX_set0_admissionAuthority()\fR and
  266. \&\fBADMISSION_SYNTAX_set0_contentsOfAdmissions()\fR
  267. functions free any existing value and set the pointer to the specified value.
  268. .PP
  269. The \fB\s-1ADMISSION\s0\fR type has an authority name, authority object, and a
  270. stack of \fB\s-1PROFESSION_INFO\s0\fR items.
  271. The \fBADMISSIONS_get0_admissionAuthority()\fR, \fBADMISSIONS_get0_namingAuthority()\fR,
  272. and \fBADMISSIONS_get0_professionInfos()\fR
  273. functions return pointers to those values within the object.
  274. The
  275. \&\fBADMISSIONS_set0_admissionAuthority()\fR,
  276. \&\fBADMISSIONS_set0_namingAuthority()\fR, and
  277. \&\fBADMISSIONS_set0_professionInfos()\fR
  278. functions free any existing value and set the pointer to the specified value.
  279. .PP
  280. The \fB\s-1PROFESSION_INFO\s0\fR type has a name authority, stacks of
  281. profession Items and OIDs, a registration number, and additional
  282. profession info.
  283. The functions \fBPROFESSION_INFO_get0_addProfessionInfo()\fR,
  284. \&\fBPROFESSION_INFO_get0_namingAuthority()\fR, \fBPROFESSION_INFO_get0_professionItems()\fR,
  285. \&\fBPROFESSION_INFO_get0_professionOIDs()\fR, and
  286. \&\fBPROFESSION_INFO_get0_registrationNumber()\fR
  287. functions return pointers to those values within the object.
  288. The
  289. \&\fBPROFESSION_INFO_set0_addProfessionInfo()\fR,
  290. \&\fBPROFESSION_INFO_set0_namingAuthority()\fR,
  291. \&\fBPROFESSION_INFO_set0_professionItems()\fR,
  292. \&\fBPROFESSION_INFO_set0_professionOIDs()\fR, and
  293. \&\fBPROFESSION_INFO_set0_registrationNumber()\fR
  294. functions free any existing value and set the pointer to the specified value.
  295. .SH "RETURN VALUES"
  296. .IX Header "RETURN VALUES"
  297. Described above.
  298. Note that all of the \fIget0\fR functions return a pointer to the internal data
  299. structure and must not be freed.
  300. .SH "SEE ALSO"
  301. .IX Header "SEE ALSO"
  302. \&\fBX509_dup\fR\|(3),
  303. \&\fBd2i_X509\fR\|(3),
  304. .SH "COPYRIGHT"
  305. .IX Header "COPYRIGHT"
  306. Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
  307. .PP
  308. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  309. this file except in compliance with the License. You can obtain a copy
  310. in the file \s-1LICENSE\s0 in the source distribution or at
  311. <https://www.openssl.org/source/license.html>.