xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/ADMISSIONS.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: ADMISSIONS.3,v 1.8 2024/09/08 13:08:14 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "ADMISSIONS 3"
ADMISSIONS 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
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
SYNOPSIS
Header "SYNOPSIS" .Vb 5 typedef struct NamingAuthority_st NAMING_AUTHORITY; typedef struct ProfessionInfo_st PROFESSION_INFO; typedef STACK_OF(PROFESSION_INFO) PROFESSION_INFOS; typedef struct Admissions_st ADMISSIONS; typedef struct AdmissionSyntax_st ADMISSION_SYNTAX; \& const ASN1_OBJECT *NAMING_AUTHORITY_get0_authorityId( const NAMING_AUTHORITY *n); void NAMING_AUTHORITY_set0_authorityId(NAMING_AUTHORITY *n, ASN1_OBJECT* namingAuthorityId); const ASN1_IA5STRING *NAMING_AUTHORITY_get0_authorityURL( const NAMING_AUTHORITY *n); void NAMING_AUTHORITY_set0_authorityURL(NAMING_AUTHORITY *n, ASN1_IA5STRING* namingAuthorityUrl); const ASN1_STRING *NAMING_AUTHORITY_get0_authorityText( const NAMING_AUTHORITY *n); void NAMING_AUTHORITY_set0_authorityText(NAMING_AUTHORITY *n, ASN1_STRING* namingAuthorityText); \& const GENERAL_NAME *ADMISSION_SYNTAX_get0_admissionAuthority( const ADMISSION_SYNTAX *as); void ADMISSION_SYNTAX_set0_admissionAuthority( ADMISSION_SYNTAX *as, GENERAL_NAME *aa); const STACK_OF(ADMISSIONS) *ADMISSION_SYNTAX_get0_contentsOfAdmissions( const ADMISSION_SYNTAX *as); void ADMISSION_SYNTAX_set0_contentsOfAdmissions( ADMISSION_SYNTAX *as, STACK_OF(ADMISSIONS) *a); \& const GENERAL_NAME *ADMISSIONS_get0_admissionAuthority(const ADMISSIONS *a); void ADMISSIONS_set0_admissionAuthority(ADMISSIONS *a, GENERAL_NAME *aa); const NAMING_AUTHORITY *ADMISSIONS_get0_namingAuthority(const ADMISSIONS *a); void ADMISSIONS_set0_namingAuthority(ADMISSIONS *a, NAMING_AUTHORITY *na); const PROFESSION_INFOS *ADMISSIONS_get0_professionInfos(const ADMISSIONS *a); void ADMISSIONS_set0_professionInfos(ADMISSIONS *a, PROFESSION_INFOS *pi); \& const ASN1_OCTET_STRING *PROFESSION_INFO_get0_addProfessionInfo( const PROFESSION_INFO *pi); void PROFESSION_INFO_set0_addProfessionInfo( PROFESSION_INFO *pi, ASN1_OCTET_STRING *aos); const NAMING_AUTHORITY *PROFESSION_INFO_get0_namingAuthority( const PROFESSION_INFO *pi); void PROFESSION_INFO_set0_namingAuthority( PROFESSION_INFO *pi, NAMING_AUTHORITY *na); const STACK_OF(ASN1_STRING) *PROFESSION_INFO_get0_professionItems( const PROFESSION_INFO *pi); void PROFESSION_INFO_set0_professionItems( PROFESSION_INFO *pi, STACK_OF(ASN1_STRING) *as); const STACK_OF(ASN1_OBJECT) *PROFESSION_INFO_get0_professionOIDs( const PROFESSION_INFO *pi); void PROFESSION_INFO_set0_professionOIDs( PROFESSION_INFO *pi, STACK_OF(ASN1_OBJECT) *po); const ASN1_PRINTABLESTRING *PROFESSION_INFO_get0_registrationNumber( const PROFESSION_INFO *pi); void PROFESSION_INFO_set0_registrationNumber( PROFESSION_INFO *pi, ASN1_PRINTABLESTRING *rn); .Ve
DESCRIPTION
Header "DESCRIPTION" The PROFESSION_INFOS, ADMISSION_SYNTAX, ADMISSIONS, and \fBPROFESSION_INFO types are opaque structures representing the analogous types defined in the Common PKI Specification published by <https://www.t7ev.org>. Knowledge of those structures and their semantics is assumed.

The conventional routines to convert between DER and the local format are described in d2i_X509\|(3). The conventional routines to allocate and free the types are defined in X509_dup\|(3).

The PROFESSION_INFOS type is a stack of PROFESSION_INFO; see \fBDEFINE_STACK_OF\|(3) for details.

The NAMING_AUTHORITY type has an authority ID and URL, and text fields. The NAMING_AUTHORITY_get0_authorityId(), \fBNAMING_AUTHORITY_get0_get0_authorityURL(), and \fBNAMING_AUTHORITY_get0_get0_authorityText(), functions return pointers to those values within the object. The NAMING_AUTHORITY_set0_authorityId(), \fBNAMING_AUTHORITY_set0_get0_authorityURL(), and \fBNAMING_AUTHORITY_set0_get0_authorityText(), functions free any existing value and set the pointer to the specified value.

The ADMISSION_SYNTAX type has an authority name and a stack of \fBADMISSION objects. The ADMISSION_SYNTAX_get0_admissionAuthority() and ADMISSION_SYNTAX_get0_contentsOfAdmissions() functions return pointers to those values within the object. The \fBADMISSION_SYNTAX_set0_admissionAuthority() and \fBADMISSION_SYNTAX_set0_contentsOfAdmissions() functions free any existing value and set the pointer to the specified value.

The ADMISSION type has an authority name, authority object, and a stack of PROFESSION_INFO items. The ADMISSIONS_get0_admissionAuthority(), ADMISSIONS_get0_namingAuthority(), and ADMISSIONS_get0_professionInfos() functions return pointers to those values within the object. The \fBADMISSIONS_set0_admissionAuthority(), \fBADMISSIONS_set0_namingAuthority(), and \fBADMISSIONS_set0_professionInfos() functions free any existing value and set the pointer to the specified value.

The PROFESSION_INFO type has a name authority, stacks of profession Items and OIDs, a registration number, and additional profession info. The functions PROFESSION_INFO_get0_addProfessionInfo(), \fBPROFESSION_INFO_get0_namingAuthority(), PROFESSION_INFO_get0_professionItems(), \fBPROFESSION_INFO_get0_professionOIDs(), and \fBPROFESSION_INFO_get0_registrationNumber() functions return pointers to those values within the object. The \fBPROFESSION_INFO_set0_addProfessionInfo(), \fBPROFESSION_INFO_set0_namingAuthority(), \fBPROFESSION_INFO_set0_professionItems(), \fBPROFESSION_INFO_set0_professionOIDs(), and \fBPROFESSION_INFO_set0_registrationNumber() functions free any existing value and set the pointer to the specified value.

"RETURN VALUES"
Header "RETURN VALUES" Described above. Note that all of the get0 functions return a pointer to the internal data structure and must not be freed.
"SEE ALSO"
Header "SEE ALSO" \fBX509_dup\|(3), \fBd2i_X509\|(3),
COPYRIGHT
Header "COPYRIGHT" Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.