Blame doc/man3/ADMISSIONS.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
ADMISSIONS,
Packit c4476c
ADMISSIONS_get0_admissionAuthority,
Packit c4476c
ADMISSIONS_get0_namingAuthority,
Packit c4476c
ADMISSIONS_get0_professionInfos,
Packit c4476c
ADMISSIONS_set0_admissionAuthority,
Packit c4476c
ADMISSIONS_set0_namingAuthority,
Packit c4476c
ADMISSIONS_set0_professionInfos,
Packit c4476c
ADMISSION_SYNTAX,
Packit c4476c
ADMISSION_SYNTAX_get0_admissionAuthority,
Packit c4476c
ADMISSION_SYNTAX_get0_contentsOfAdmissions,
Packit c4476c
ADMISSION_SYNTAX_set0_admissionAuthority,
Packit c4476c
ADMISSION_SYNTAX_set0_contentsOfAdmissions,
Packit c4476c
NAMING_AUTHORITY,
Packit c4476c
NAMING_AUTHORITY_get0_authorityId,
Packit c4476c
NAMING_AUTHORITY_get0_authorityURL,
Packit c4476c
NAMING_AUTHORITY_get0_authorityText,
Packit c4476c
NAMING_AUTHORITY_set0_authorityId,
Packit c4476c
NAMING_AUTHORITY_set0_authorityURL,
Packit c4476c
NAMING_AUTHORITY_set0_authorityText,
Packit c4476c
PROFESSION_INFO,
Packit c4476c
PROFESSION_INFOS,
Packit c4476c
PROFESSION_INFO_get0_addProfessionInfo,
Packit c4476c
PROFESSION_INFO_get0_namingAuthority,
Packit c4476c
PROFESSION_INFO_get0_professionItems,
Packit c4476c
PROFESSION_INFO_get0_professionOIDs,
Packit c4476c
PROFESSION_INFO_get0_registrationNumber,
Packit c4476c
PROFESSION_INFO_set0_addProfessionInfo,
Packit c4476c
PROFESSION_INFO_set0_namingAuthority,
Packit c4476c
PROFESSION_INFO_set0_professionItems,
Packit c4476c
PROFESSION_INFO_set0_professionOIDs,
Packit c4476c
PROFESSION_INFO_set0_registrationNumber
Packit c4476c
- Accessors and settors for ADMISSION_SYNTAX
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 typedef struct NamingAuthority_st NAMING_AUTHORITY;
Packit c4476c
 typedef struct ProfessionInfo_st PROFESSION_INFO;
Packit c4476c
 typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS;
Packit c4476c
 typedef struct Admissions_st ADMISSIONS;
Packit c4476c
 typedef struct AdmissionSyntax_st ADMISSION_SYNTAX;
Packit c4476c
Packit c4476c
 const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId(
Packit c4476c
     const NAMING_AUTHORITY *n);
Packit c4476c
 void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n,
Packit c4476c
     ASN1_OBJECT* namingAuthorityId);
Packit c4476c
 const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL(
Packit c4476c
     const NAMING_AUTHORITY *n);
Packit c4476c
 void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n,
Packit c4476c
     ASN1_IA5STRING* namingAuthorityUrl);
Packit c4476c
 const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText(
Packit c4476c
     const NAMING_AUTHORITY *n);
Packit c4476c
 void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n,
Packit c4476c
     ASN1_STRING* namingAuthorityText);
Packit c4476c
Packit c4476c
 const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority(
Packit c4476c
     const ADMISSION_SYNTAX *as);
Packit c4476c
 void ADMISSION_SYNTAX_set0_admissionAuthority(
Packit c4476c
     ADMISSION_SYNTAX *as, GENERAL_NAME *aa);
Packit c4476c
 const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions(
Packit c4476c
     const ADMISSION_SYNTAX *as);
Packit c4476c
 void ADMISSION_SYNTAX_set0_contentsOfAdmissions(
Packit c4476c
     ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a);
Packit c4476c
Packit c4476c
 const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a);
Packit c4476c
 void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa);
Packit c4476c
 const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a);
Packit c4476c
 void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na);
Packit c4476c
 const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a);
Packit c4476c
 void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi);
Packit c4476c
Packit c4476c
 const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo(
Packit c4476c
     const PROFESSION_INFO *pi);
Packit c4476c
 void PROFESSION_INFO_set0_addProfessionInfo(
Packit c4476c
     PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos);
Packit c4476c
 const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority(
Packit c4476c
     const PROFESSION_INFO *pi);
Packit c4476c
 void PROFESSION_INFO_set0_namingAuthority(
Packit c4476c
     PROFESSION_INFO *pi, NAMING_AUTHORITY *na);
Packit c4476c
 const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems(
Packit c4476c
     const PROFESSION_INFO *pi);
Packit c4476c
 void PROFESSION_INFO_set0_professionItems(
Packit c4476c
     PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as);
Packit c4476c
 const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs(
Packit c4476c
     const PROFESSION_INFO *pi);
Packit c4476c
 void PROFESSION_INFO_set0_professionOIDs(
Packit c4476c
     PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po);
Packit c4476c
 const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber(
Packit c4476c
     const PROFESSION_INFO *pi);
Packit c4476c
 void PROFESSION_INFO_set0_registrationNumber(
Packit c4476c
     PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The B<PROFESSION_INFOS>, B<ADMISSION_SYNTAX>, B<ADMISSIONS>, and
Packit c4476c
B<PROFESSION_INFO> types are opaque structures representing the
Packit c4476c
analogous types defined in the Common PKI Specification published
Packit c4476c
by L<https://www.t7ev.org>.
Packit c4476c
Knowledge of those structures and their semantics is assumed.
Packit c4476c
Packit c4476c
The conventional routines to convert between DER and the local format
Packit c4476c
are described in L<d2i_X509(3)>.
Packit c4476c
The conventional routines to allocate and free the types are defined
Packit c4476c
in L<X509_dup(3)>.
Packit c4476c
Packit c4476c
The B<PROFESSION_INFOS> type is a stack of B<PROFESSION_INFO>; see
Packit c4476c
L<DEFINE_STACK_OF(3)> for details.
Packit c4476c
Packit c4476c
The B<NAMING_AUTHORITY> type has an authority ID and URL, and text fields.
Packit c4476c
The NAMING_AUTHORITY_get0_authorityId(),
Packit c4476c
NAMING_AUTHORITY_get0_get0_authorityURL(), and
Packit c4476c
NAMING_AUTHORITY_get0_get0_authorityText(), functions return pointers
Packit c4476c
to those values within the object.
Packit c4476c
The NAMING_AUTHORITY_set0_authorityId(),
Packit c4476c
NAMING_AUTHORITY_set0_get0_authorityURL(), and
Packit c4476c
NAMING_AUTHORITY_set0_get0_authorityText(),
Packit c4476c
functions free any existing value and set the pointer to the specified value.
Packit c4476c
Packit c4476c
The B<ADMISSION_SYNTAX> type has an authority name and a stack of
Packit c4476c
B<ADMISSION> objects.
Packit c4476c
The ADMISSION_SYNTAX_get0_admissionAuthority()
Packit c4476c
and ADMISSION_SYNTAX_get0_contentsOfAdmissions() functions return pointers
Packit c4476c
to those values within the object.
Packit c4476c
The
Packit c4476c
ADMISSION_SYNTAX_set0_admissionAuthority() and
Packit c4476c
ADMISSION_SYNTAX_set0_contentsOfAdmissions()
Packit c4476c
functions free any existing value and set the pointer to the specified value.
Packit c4476c
Packit c4476c
The B<ADMISSION> type has an authority name, authority object, and a
Packit c4476c
stack of B<PROFESSION_INFO> items.
Packit c4476c
The ADMISSIONS_get0_admissionAuthority(), ADMISSIONS_get0_namingAuthority(),
Packit c4476c
and ADMISSIONS_get0_professionInfos()
Packit c4476c
functions return pointers to those values within the object.
Packit c4476c
The
Packit c4476c
ADMISSIONS_set0_admissionAuthority(),
Packit c4476c
ADMISSIONS_set0_namingAuthority(), and
Packit c4476c
ADMISSIONS_set0_professionInfos()
Packit c4476c
functions free any existing value and set the pointer to the specified value.
Packit c4476c
Packit c4476c
The B<PROFESSION_INFO> type has a name authority, stacks of
Packit c4476c
profession Items and OIDs, a registration number, and additional
Packit c4476c
profession info.
Packit c4476c
The functions PROFESSION_INFO_get0_addProfessionInfo(),
Packit c4476c
PROFESSION_INFO_get0_namingAuthority(), PROFESSION_INFO_get0_professionItems(),
Packit c4476c
PROFESSION_INFO_get0_professionOIDs(), and
Packit c4476c
PROFESSION_INFO_get0_registrationNumber()
Packit c4476c
functions return pointers to those values within the object.
Packit c4476c
The
Packit c4476c
PROFESSION_INFO_set0_addProfessionInfo(),
Packit c4476c
PROFESSION_INFO_set0_namingAuthority(),
Packit c4476c
PROFESSION_INFO_set0_professionItems(),
Packit c4476c
PROFESSION_INFO_set0_professionOIDs(), and
Packit c4476c
PROFESSION_INFO_set0_registrationNumber()
Packit c4476c
functions free any existing value and set the pointer to the specified value.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
Described above.
Packit c4476c
Note that all of the I<get0> functions return a pointer to the internal data
Packit c4476c
structure and must not be freed.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<X509_dup(3)>,
Packit c4476c
L<d2i_X509(3)>,
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut