ADMISSIONS.pod 6.9 KB

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