xref: /openbsd-src/lib/libcrypto/man/X509_get_subject_name.3 (revision 5d332758ce6df2ab934323c71f9a5d0e17cba048)

.\"	$OpenBSD: X509_get_subject_name.3,v 1.10 2020/10/21 17:17:44 tb Exp $
.\"	OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
.\"
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
.\" Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: October 21 2020 $
.Dt X509_GET_SUBJECT_NAME 3
.Os
.Sh NAME
.Nm X509_get_subject_name ,
.Nm X509_set_subject_name ,
.Nm X509_get_issuer_name ,
.Nm X509_set_issuer_name ,
.Nm X509_REQ_get_subject_name ,
.Nm X509_REQ_set_subject_name ,
.Nm X509_CRL_get_issuer ,
.Nm X509_CRL_set_issuer_name
.Nd get and set issuer or subject names
.Sh SYNOPSIS
.In openssl/x509.h
.Ft X509_NAME *
.Fo X509_get_subject_name
.Fa "const X509 *x"
.Fc
.Ft int
.Fo X509_set_subject_name
.Fa "X509 *x"
.Fa "X509_NAME *name"
.Fc
.Ft X509_NAME *
.Fo X509_get_issuer_name
.Fa "const X509 *x"
.Fc
.Ft int
.Fo X509_set_issuer_name
.Fa "X509 *x"
.Fa "X509_NAME *name"
.Fc
.Ft X509_NAME *
.Fo X509_REQ_get_subject_name
.Fa "const X509_REQ *req"
.Fc
.Ft int
.Fo X509_REQ_set_subject_name
.Fa "X509_REQ *req"
.Fa "X509_NAME *name"
.Fc
.Ft X509_NAME *
.Fo X509_CRL_get_issuer
.Fa "const X509_CRL *crl"
.Fc
.Ft int
.Fo X509_CRL_set_issuer_name
.Fa "X509_CRL *x"
.Fa "X509_NAME *name"
.Fc
.Sh DESCRIPTION
.Fn X509_get_subject_name
returns the subject name of certificate
.Fa x .
The returned value is an internal pointer which must not be freed.
.Pp
.Fn X509_set_subject_name
sets the issuer name of certificate
.Fa x
to
.Fa name .
The
.Fa name
parameter is copied internally and should be freed up when it is no
longer needed.
.Pp
.Fn X509_get_issuer_name
and
.Fn X509_set_issuer_name
are identical to
.Fn X509_get_subject_name
and
.Fn X509_set_subject_name
except that they get and set the issuer name of
.Fa x .
.Pp
Similarly
.Fn X509_REQ_get_subject_name ,
.Fn X509_REQ_set_subject_name ,
.Fn X509_CRL_get_issuer ,
and
.Fn X509_CRL_set_issuer_name
get or set the subject or issuer names of certificate requests
of CRLs, respectively.
.Sh RETURN VALUES
.Fn X509_get_subject_name ,
.Fn X509_get_issuer_name ,
.Fn X509_REQ_get_subject_name ,
and
.Fn X509_CRL_get_issuer
return a pointer to an
.Vt X509_NAME
object.
.Pp
.Fn X509_set_subject_name ,
.Fn X509_set_issuer_name ,
.Fn X509_REQ_set_subject_name ,
and
.Fn X509_CRL_set_issuer_name
return 1 for success or 0 for failure.
In some cases of failure, the reason can be determined with
.Xr ERR_get_error 3 .
.Sh SEE ALSO
.Xr d2i_X509_NAME 3 ,
.Xr X509_CRL_get0_by_serial 3 ,
.Xr X509_CRL_new 3 ,
.Xr X509_get_pubkey 3 ,
.Xr X509_NAME_add_entry_by_txt 3 ,
.Xr X509_NAME_ENTRY_get_object 3 ,
.Xr X509_NAME_get_index_by_NID 3 ,
.Xr X509_NAME_new 3 ,
.Xr X509_NAME_print_ex 3 ,
.Xr X509_new 3 ,
.Xr X509_REQ_new 3 ,
.Xr X509_sign 3 ,
.Xr X509_verify_cert 3 ,
.Xr X509V3_get_d2i 3
.Sh HISTORY
.Fn X509_get_subject_name
and
.Fn X509_get_issuer_name
appeared in SSLeay 0.4 or earlier.
.Fn X509_set_subject_name ,
.Fn X509_set_issuer_name ,
.Fn X509_REQ_get_subject_name ,
and
.Fn X509_REQ_set_subject_name
first appeared in SSLeay 0.6.5.
These functions have been available since
.Ox 2.4 .
.Pp
.Fn X509_CRL_get_issuer
first appeared in OpenSSL 0.9.2b and has been available since
.Ox 2.6 .
.Pp
.Fn X509_CRL_set_issuer_name
first appeared in OpenSSL 0.9.7 and has been available since
.Ox 3.2 .