secure/lib/libcrypto/man/X509_EXTENSION_set_object.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "X509_EXTENSION_SET_OBJECT 3"
 132 .TH X509_EXTENSION_SET_OBJECT 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 X509_EXTENSION_set_object, X509_EXTENSION_set_critical, X509_EXTENSION_set_data, X509_EXTENSION_create_by_NID, X509_EXTENSION_create_by_OBJ, X509_EXTENSION_get_object, X509_EXTENSION_get_critical, X509_EXTENSION_get_data \- extension utility functions
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 3
 142 \& int X509_EXTENSION_set_object(X509_EXTENSION *ex, const ASN1_OBJECT *obj);
 143 \& int X509_EXTENSION_set_critical(X509_EXTENSION *ex, int crit);
 144 \& int X509_EXTENSION_set_data(X509_EXTENSION *ex, ASN1_OCTET_STRING *data);
 145 \&
 146 \& X509_EXTENSION *X509_EXTENSION_create_by_NID(X509_EXTENSION **ex,
 147 \&                                              int nid, int crit,
 148 \&                                              ASN1_OCTET_STRING *data);
 149 \& X509_EXTENSION *X509_EXTENSION_create_by_OBJ(X509_EXTENSION **ex,
 150 \&                                              const ASN1_OBJECT *obj, int crit,
 151 \&                                              ASN1_OCTET_STRING *data);
 152 \&
 153 \& ASN1_OBJECT *X509_EXTENSION_get_object(X509_EXTENSION *ex);
 154 \& int X509_EXTENSION_get_critical(const X509_EXTENSION *ex);
 155 \& ASN1_OCTET_STRING *X509_EXTENSION_get_data(X509_EXTENSION *ne);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fIX509_EXTENSION_set_object()\fR sets the extension type of \fBex\fR to \fBobj\fR. The
 160 \&\fBobj\fR pointer is duplicated internally so \fBobj\fR should be freed up after use.
 161 .PP
 162 \&\fIX509_EXTENSION_set_critical()\fR sets the criticality of \fBex\fR to \fBcrit\fR. If
 163 \&\fBcrit\fR is zero the extension in non-critical otherwise it is critical.
 164 .PP
 165 \&\fIX509_EXTENSION_set_data()\fR sets the data in extension \fBex\fR to \fBdata\fR. The
 166 \&\fBdata\fR pointer is duplicated internally.
 167 .PP
 168 \&\fIX509_EXTENSION_create_by_NID()\fR creates an extension of type \fBnid\fR,
 169 criticality \fBcrit\fR using data \fBdata\fR. The created extension is returned and
 170 written to \fB*ex\fR reusing or allocating a new extension if necessary so \fB*ex\fR
 171 should either be \fB\s-1NULL\s0\fR or a valid \fBX509_EXTENSION\fR structure it must
 172 \&\fBnot\fR be an uninitialised pointer.
 173 .PP
 174 \&\fIX509_EXTENSION_create_by_OBJ()\fR is identical to \fIX509_EXTENSION_create_by_NID()\fR
 175 except it creates and extension using \fBobj\fR instead of a \s-1NID.\s0
 176 .PP
 177 \&\fIX509_EXTENSION_get_object()\fR returns the extension type of \fBex\fR as an
 178 \&\fB\s-1ASN1_OBJECT\s0\fR pointer. The returned pointer is an internal value which must
 179 not be freed up.
 180 .PP
 181 \&\fIX509_EXTENSION_get_critical()\fR returns the criticality of extension \fBex\fR it
 182 returns \fB1\fR for critical and \fB0\fR for non-critical.
 183 .PP
 184 \&\fIX509_EXTENSION_get_data()\fR returns the data of extension \fBex\fR. The returned
 185 pointer is an internal value which must not be freed up.
 186 .SH "NOTES"
 187 .IX Header "NOTES"
 188 These functions manipulate the contents of an extension directly. Most
 189 applications will want to parse or encode and add an extension: they should
 190 use the extension encode and decode functions instead such as
 191 \&\fIX509_add1_ext_i2d()\fR and \fIX509_get_ext_d2i()\fR.
 192 .PP
 193 The \fBdata\fR associated with an extension is the extension encoding in an
 194 \&\fB\s-1ASN1_OCTET_STRING\s0\fR structure.
 195 .SH "RETURN VALUES"
 196 .IX Header "RETURN VALUES"
 197 \&\fIX509_EXTENSION_set_object()\fR \fIX509_EXTENSION_set_critical()\fR and
 198 \&\fIX509_EXTENSION_set_data()\fR return \fB1\fR for success and \fB0\fR for failure.
 199 .PP
 200 \&\fIX509_EXTENSION_create_by_NID()\fR and \fIX509_EXTENSION_create_by_OBJ()\fR return
 201 an \fBX509_EXTENSION\fR pointer or \fB\s-1NULL\s0\fR if an error occurs.
 202 .PP
 203 \&\fIX509_EXTENSION_get_object()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR pointer.
 204 .PP
 205 \&\fIX509_EXTENSION_get_critical()\fR returns \fB0\fR for non-critical and \fB1\fR for
 206 critical.
 207 .PP
 208 \&\fIX509_EXTENSION_get_data()\fR returns an \fB\s-1ASN1_OCTET_STRING\s0\fR pointer.
 209 .SH "SEE ALSO"
 210 .IX Header "SEE ALSO"
 211 \&\fIX509V3_get_d2i\fR\|(3)
 212 .SH "COPYRIGHT"
 213 .IX Header "COPYRIGHT"
 214 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 215 .PP
 216 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 217 this file except in compliance with the License.  You can obtain a copy
 218 in the file \s-1LICENSE\s0 in the source distribution or at
 219 <https://www.openssl.org/source/license.html>.