1.\"	$OpenBSD: X509_get_subject_name.3,v 1.9 2019/06/14 13:59:32 schwarze Exp $
2.\"	OpenSSL 0ad69cd6 Jun 14 23:02:16 2016 +0200
3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: June 14 2019 $
52.Dt X509_GET_SUBJECT_NAME 3
53.Os
54.Sh NAME
55.Nm X509_get_subject_name ,
56.Nm X509_set_subject_name ,
57.Nm X509_get_issuer_name ,
58.Nm X509_set_issuer_name ,
59.Nm X509_REQ_get_subject_name ,
60.Nm X509_REQ_set_subject_name ,
61.Nm X509_CRL_get_issuer ,
62.Nm X509_CRL_set_issuer_name
63.Nd get and set issuer or subject names
64.Sh SYNOPSIS
65.In openssl/x509.h
66.Ft X509_NAME *
67.Fo X509_get_subject_name
68.Fa "const X509 *x"
69.Fc
70.Ft int
71.Fo X509_set_subject_name
72.Fa "X509 *x"
73.Fa "X509_NAME *name"
74.Fc
75.Ft X509_NAME *
76.Fo X509_get_issuer_name
77.Fa "const X509 *x"
78.Fc
79.Ft int
80.Fo X509_set_issuer_name
81.Fa "X509 *x"
82.Fa "X509_NAME *name"
83.Fc
84.Ft X509_NAME *
85.Fo X509_REQ_get_subject_name
86.Fa "const X509_REQ *req"
87.Fc
88.Ft int
89.Fo X509_REQ_set_subject_name
90.Fa "X509_REQ *req"
91.Fa "X509_NAME *name"
92.Fc
93.Ft X509_NAME *
94.Fo X509_CRL_get_issuer
95.Fa "const X509_CRL *crl"
96.Fc
97.Ft int
98.Fo X509_CRL_set_issuer_name
99.Fa "X509_CRL *x"
100.Fa "X509_NAME *name"
101.Fc
102.Sh DESCRIPTION
103.Fn X509_get_subject_name
104returns the subject name of certificate
105.Fa x .
106The returned value is an internal pointer which must not be freed.
107.Pp
108.Fn X509_set_subject_name
109sets the issuer name of certificate
110.Fa x
111to
112.Fa name .
113The
114.Fa name
115parameter is copied internally and should be freed up when it is no
116longer needed.
117.Pp
118.Fn X509_get_issuer_name
119and
120.Fn X509_set_issuer_name
121are identical to
122.Fn X509_get_subject_name
123and
124.Fn X509_set_subject_name
125except that they get and set the issuer name of
126.Fa x .
127.Pp
128Similarly
129.Fn X509_REQ_get_subject_name ,
130.Fn X509_REQ_set_subject_name ,
131.Fn X509_CRL_get_issuer ,
132and
133.Fn X509_CRL_set_issuer_name
134get or set the subject or issuer names of certificate requests
135of CRLs, respectively.
136.Pp
137.Fn X509_REQ_get_subject_name
138and
139.Fn X509_CRL_get_issuer
140are implemented as macros.
141.Sh RETURN VALUES
142.Fn X509_get_subject_name ,
143.Fn X509_get_issuer_name ,
144.Fn X509_REQ_get_subject_name ,
145and
146.Fn X509_CRL_get_issuer
147return a pointer to an
148.Vt X509_NAME
149object.
150.Pp
151.Fn X509_set_subject_name ,
152.Fn X509_set_issuer_name ,
153.Fn X509_REQ_set_subject_name ,
154and
155.Fn X509_CRL_set_issuer_name
156return 1 for success or 0 for failure.
157In some cases of failure, the reason can be determined with
158.Xr ERR_get_error 3 .
159.Sh SEE ALSO
160.Xr d2i_X509_NAME 3 ,
161.Xr X509_CRL_get0_by_serial 3 ,
162.Xr X509_CRL_new 3 ,
163.Xr X509_get_pubkey 3 ,
164.Xr X509_NAME_add_entry_by_txt 3 ,
165.Xr X509_NAME_ENTRY_get_object 3 ,
166.Xr X509_NAME_get_index_by_NID 3 ,
167.Xr X509_NAME_new 3 ,
168.Xr X509_NAME_print_ex 3 ,
169.Xr X509_new 3 ,
170.Xr X509_REQ_new 3 ,
171.Xr X509_sign 3 ,
172.Xr X509_verify_cert 3 ,
173.Xr X509V3_get_d2i 3
174.Sh HISTORY
175.Fn X509_get_subject_name
176and
177.Fn X509_get_issuer_name
178appeared in SSLeay 0.4 or earlier.
179.Fn X509_set_subject_name ,
180.Fn X509_set_issuer_name ,
181.Fn X509_REQ_get_subject_name ,
182and
183.Fn X509_REQ_set_subject_name
184first appeared in SSLeay 0.6.5.
185These functions have been available since
186.Ox 2.4 .
187.Pp
188.Fn X509_CRL_get_issuer
189first appeared in OpenSSL 0.9.2b and has been available since
190.Ox 2.6 .
191.Pp
192.Fn X509_CRL_set_issuer_name
193first appeared in OpenSSL 0.9.7 and has been available since
194.Ox 3.2 .
195