xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/X509_EXTENSION_set_object.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: X509_EXTENSION_set_object.3,v 1.9 2024/09/08 13:08:36 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 "X509_EXTENSION_set_object 3"
X509_EXTENSION_set_object 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
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
SYNOPSIS
Header "SYNOPSIS" .Vb 3 int X509_EXTENSION_set_object(X509_EXTENSION *ex, const ASN1_OBJECT *obj); int X509_EXTENSION_set_critical(X509_EXTENSION *ex, int crit); int X509_EXTENSION_set_data(X509_EXTENSION *ex, ASN1_OCTET_STRING *data); \& X509_EXTENSION *X509_EXTENSION_create_by_NID(X509_EXTENSION **ex, int nid, int crit, ASN1_OCTET_STRING *data); X509_EXTENSION *X509_EXTENSION_create_by_OBJ(X509_EXTENSION **ex, const ASN1_OBJECT *obj, int crit, ASN1_OCTET_STRING *data); \& ASN1_OBJECT *X509_EXTENSION_get_object(X509_EXTENSION *ex); int X509_EXTENSION_get_critical(const X509_EXTENSION *ex); ASN1_OCTET_STRING *X509_EXTENSION_get_data(X509_EXTENSION *ne); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBX509_EXTENSION_set_object() sets the extension type of ex to obj. The \fBobj pointer is duplicated internally so obj should be freed up after use.

\fBX509_EXTENSION_set_critical() sets the criticality of ex to crit. If \fBcrit is zero the extension in non-critical otherwise it is critical.

\fBX509_EXTENSION_set_data() sets the data in extension ex to data. The \fBdata pointer is duplicated internally.

\fBX509_EXTENSION_create_by_NID() creates an extension of type nid, criticality crit using data data. The created extension is returned and written to *ex reusing or allocating a new extension if necessary so *ex should either be NULL or a valid X509_EXTENSION structure it must \fBnot be an uninitialised pointer.

\fBX509_EXTENSION_create_by_OBJ() is identical to X509_EXTENSION_create_by_NID() except it creates and extension using obj instead of a NID.

\fBX509_EXTENSION_get_object() returns the extension type of ex as an \fBASN1_OBJECT pointer. The returned pointer is an internal value which must not be freed up.

\fBX509_EXTENSION_get_critical() returns the criticality of extension ex it returns 1 for critical and 0 for non-critical.

\fBX509_EXTENSION_get_data() returns the data of extension ex. The returned pointer is an internal value which must not be freed up.

NOTES
Header "NOTES" These functions manipulate the contents of an extension directly. Most applications will want to parse or encode and add an extension: they should use the extension encode and decode functions instead such as \fBX509_add1_ext_i2d() and X509_get_ext_d2i().

The data associated with an extension is the extension encoding in an \fBASN1_OCTET_STRING structure.

"RETURN VALUES"
Header "RETURN VALUES" \fBX509_EXTENSION_set_object() X509_EXTENSION_set_critical() and \fBX509_EXTENSION_set_data() return 1 for success and 0 for failure.

\fBX509_EXTENSION_create_by_NID() and X509_EXTENSION_create_by_OBJ() return an X509_EXTENSION pointer or NULL if an error occurs.

\fBX509_EXTENSION_get_object() returns an ASN1_OBJECT pointer.

\fBX509_EXTENSION_get_critical() returns 0 for non-critical and 1 for critical.

\fBX509_EXTENSION_get_data() returns an ASN1_OCTET_STRING pointer.

"SEE ALSO"
Header "SEE ALSO" \fBX509V3_get_d2i\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2015-2016 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>.