Debian Codegraph @

upstream/debian-unstable/man3/SSL_CONF_CTX_set1_prefix.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 "SSL_CONF_CTX_SET1_PREFIX 3SSL"
58 .TH SSL_CONF_CTX_SET1_PREFIX 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 SSL_CONF_CTX_set1_prefix \- Set configuration context command prefix
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& unsigned int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *prefix);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 The function \fBSSL_CONF_CTX_set1_prefix()\fR sets the command prefix of \fBcctx\fR
75 to \fBprefix\fR. If \fBprefix\fR is \fBNULL\fR it is restored to the default value.
76 .SH NOTES
77 .IX Header "NOTES"
78 Command prefixes alter the commands recognised by subsequent \fBSSL_CONF_cmd()\fR
79 calls. For example for files, if the prefix "SSL" is set then command names
80 such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol"
81 and "Options". Similarly for command lines if the prefix is "\-\-ssl\-" then
82 "\-\-ssl\-no_tls1_2" is recognised instead of "\-no_tls1_2".
83 .PP
84 If the \fBSSL_CONF_FLAG_CMDLINE\fR flag is set then prefix checks are case
85 sensitive and "\-" is the default. In the unlikely even an application
86 explicitly wants to set no prefix it must be explicitly set to "".
87 .PP
88 If the \fBSSL_CONF_FLAG_FILE\fR flag is set then prefix checks are case
89 insensitive and no prefix is the default.
90 .SH "RETURN VALUES"
91 .IX Header "RETURN VALUES"
92 \&\fBSSL_CONF_CTX_set1_prefix()\fR returns 1 for success and 0 for failure.
93 .SH "SEE ALSO"
94 .IX Header "SEE ALSO"
95 \&\fBssl\fR\|(7),
96 \&\fBSSL_CONF_CTX_new\fR\|(3),
97 \&\fBSSL_CONF_CTX_set_flags\fR\|(3),
98 \&\fBSSL_CONF_CTX_set_ssl_ctx\fR\|(3),
99 \&\fBSSL_CONF_cmd\fR\|(3),
100 \&\fBSSL_CONF_cmd_argv\fR\|(3)
101 .SH HISTORY
102 .IX Header "HISTORY"
103 These functions were added in OpenSSL 1.0.2.
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2012\-2016 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.