303 lines
11 KiB
Groff
Executable File
303 lines
11 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "ADMISSIONS 3"
|
|
.TH ADMISSIONS 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "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
|
|
.SH "SYNOPSIS"
|
|
.IX 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
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fB\s-1PROFESSION_INFOS\s0\fR, \fB\s-1ADMISSION_SYNTAX\s0\fR, \fB\s-1ADMISSIONS\s0\fR, and
|
|
\&\fB\s-1PROFESSION_INFO\s0\fR types are opaque structures representing the
|
|
analogous types defined in the Common \s-1PKI\s0 Specification published
|
|
by <https://www.t7ev.org>.
|
|
Knowledge of those structures and their semantics is assumed.
|
|
.PP
|
|
The conventional routines to convert between \s-1DER\s0 and the local format
|
|
are described in \fId2i_X509\fR\|(3).
|
|
The conventional routines to allocate and free the types are defined
|
|
in \fIX509_dup\fR\|(3).
|
|
.PP
|
|
The \fB\s-1PROFESSION_INFOS\s0\fR type is a stack of \fB\s-1PROFESSION_INFO\s0\fR; see
|
|
\&\s-1\fIDEFINE_STACK_OF\s0\fR\|(3) for details.
|
|
.PP
|
|
The \fB\s-1NAMING_AUTHORITY\s0\fR type has an authority \s-1ID\s0 and \s-1URL\s0, and text fields.
|
|
The \fINAMING_AUTHORITY_get0_authorityId()\fR,
|
|
\&\fINAMING_AUTHORITY_get0_get0_authorityURL()\fR, and
|
|
\&\fINAMING_AUTHORITY_get0_get0_authorityText()\fR, functions return pointers
|
|
to those values within the object.
|
|
The \fINAMING_AUTHORITY_set0_authorityId()\fR,
|
|
\&\fINAMING_AUTHORITY_set0_get0_authorityURL()\fR, and
|
|
\&\fINAMING_AUTHORITY_set0_get0_authorityText()\fR,
|
|
functions free any existing value and set the pointer to the specified value.
|
|
.PP
|
|
The \fB\s-1ADMISSION_SYNTAX\s0\fR type has an authority name and a stack of
|
|
\&\fB\s-1ADMISSION\s0\fR objects.
|
|
The \fIADMISSION_SYNTAX_get0_admissionAuthority()\fR
|
|
and \fIADMISSION_SYNTAX_get0_contentsOfAdmissions()\fR functions return pointers
|
|
to those values within the object.
|
|
The
|
|
\&\fIADMISSION_SYNTAX_set0_admissionAuthority()\fR and
|
|
\&\fIADMISSION_SYNTAX_set0_contentsOfAdmissions()\fR
|
|
functions free any existing value and set the pointer to the specified value.
|
|
.PP
|
|
The \fB\s-1ADMISSION\s0\fR type has an authority name, authority object, and a
|
|
stack of \fB\s-1PROFESSION_INFO\s0\fR items.
|
|
The \fIADMISSIONS_get0_admissionAuthority()\fR, \fIADMISSIONS_get0_namingAuthority()\fR,
|
|
and \fIADMISSIONS_get0_professionInfos()\fR
|
|
functions return pointers to those values within the object.
|
|
The
|
|
\&\fIADMISSIONS_set0_admissionAuthority()\fR,
|
|
\&\fIADMISSIONS_set0_namingAuthority()\fR, and
|
|
\&\fIADMISSIONS_set0_professionInfos()\fR
|
|
functions free any existing value and set the pointer to the specified value.
|
|
.PP
|
|
The \fB\s-1PROFESSION_INFO\s0\fR type has a name authority, stacks of
|
|
profession Items and OIDs, a registration number, and additional
|
|
profession info.
|
|
The functions \fIPROFESSION_INFO_get0_addProfessionInfo()\fR,
|
|
\&\fIPROFESSION_INFO_get0_namingAuthority()\fR, \fIPROFESSION_INFO_get0_professionItems()\fR,
|
|
\&\fIPROFESSION_INFO_get0_professionOIDs()\fR, and
|
|
\&\fIPROFESSION_INFO_get0_registrationNumber()\fR
|
|
functions return pointers to those values within the object.
|
|
The
|
|
\&\fIPROFESSION_INFO_set0_addProfessionInfo()\fR,
|
|
\&\fIPROFESSION_INFO_set0_namingAuthority()\fR,
|
|
\&\fIPROFESSION_INFO_set0_professionItems()\fR,
|
|
\&\fIPROFESSION_INFO_set0_professionOIDs()\fR, and
|
|
\&\fIPROFESSION_INFO_set0_registrationNumber()\fR
|
|
functions free any existing value and set the pointer to the specified value.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
Described above.
|
|
Note that all of the \fIget0\fR functions return a pointer to the internal data
|
|
structure and must not be freed.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIX509_dup\fR\|(3),
|
|
\&\fId2i_X509\fR\|(3),
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|