Debian Codegraph @

upstream/debian-unstable/man3/X509_STORE_CTX_get_by_subject.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_STORE_CTX_GET_BY_SUBJECT 3SSL"
58 .TH X509_STORE_CTX_GET_BY_SUBJECT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_STORE_CTX_get_by_subject,
65 X509_STORE_CTX_get_obj_by_subject
66 \&\- X509 and X509_CRL lookup functions
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509_vfy.h>
71 \&
72 \& int X509_STORE_CTX_get_by_subject(const X509_STORE_CTX *vs,
73 \& X509_LOOKUP_TYPE type,
74 \& const X509_NAME *name, X509_OBJECT *ret);
75 \& X509_OBJECT *X509_STORE_CTX_get_obj_by_subject(X509_STORE_CTX *vs,
76 \& X509_LOOKUP_TYPE type,
77 \& const X509_NAME *name);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\fBX509_STORE_CTX_get_by_subject()\fR tries to find an object
82 of given \fItype\fR, which may be \fBX509_LU_X509\fR or \fBX509_LU_CRL\fR,
83 and subject \fIname\fR from the store in the provided store context \fIvs\fR.
84 If found and \fIret\fR is not NULL, it increments the reference count and
85 stores the looked up object in \fIret\fR.
86 .PP
87 \&\fBX509_STORE_CTX_get_obj_by_subject()\fR is like \fBX509_STORE_CTX_get_by_subject()\fR
88 but returns the found object on success, else NULL.
89 .SH "RETURN VALUES"
90 .IX Header "RETURN VALUES"
91 \&\fBX509_STORE_CTX_get_by_subject()\fR returns 1 if the lookup was successful, else 0.
92 .PP
93 \&\fBX509_STORE_CTX_get_obj_by_subject()\fR returns an object on success, else NULL.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBX509_LOOKUP_meth_set_get_by_subject\fR\|(3),
97 \&\fBX509_LOOKUP_by_subject\fR\|(3)
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.