diff options
Diffstat (limited to 'src/lib/libcrypto/man/ENGINE_set_flags.3')
-rw-r--r-- | src/lib/libcrypto/man/ENGINE_set_flags.3 | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_set_flags.3 b/src/lib/libcrypto/man/ENGINE_set_flags.3 new file mode 100644 index 0000000000..a4ac107f9e --- /dev/null +++ b/src/lib/libcrypto/man/ENGINE_set_flags.3 | |||
@@ -0,0 +1,79 @@ | |||
1 | .\" $OpenBSD: ENGINE_set_flags.3,v 1.1 2018/04/15 17:02:03 schwarze Exp $ | ||
2 | .\" content checked up to: | ||
3 | .\" OpenSSL ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800 | ||
4 | .\" | ||
5 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | ||
6 | .\" | ||
7 | .\" Permission to use, copy, modify, and distribute this software for any | ||
8 | .\" purpose with or without fee is hereby granted, provided that the above | ||
9 | .\" copyright notice and this permission notice appear in all copies. | ||
10 | .\" | ||
11 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
12 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
13 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
14 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
15 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
16 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
17 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
18 | .\" | ||
19 | .Dd $Mdocdate: April 15 2018 $ | ||
20 | .Dt ENGINE_SET_FLAGS 3 | ||
21 | .Os | ||
22 | .Sh NAME | ||
23 | .Nm ENGINE_set_flags , | ||
24 | .Nm ENGINE_get_flags | ||
25 | .Nd modify the behaviour of an ENGINE object | ||
26 | .Sh SYNOPSIS | ||
27 | .In openssl/engine.h | ||
28 | .Ft int | ||
29 | .Fo ENGINE_set_flags | ||
30 | .Fa "ENGINE *e" | ||
31 | .Fa "int flags" | ||
32 | .Fc | ||
33 | .Ft int | ||
34 | .Fo ENGINE_get_flags | ||
35 | .Fa "const ENGINE *e" | ||
36 | .Fc | ||
37 | .Sh DESCRIPTION | ||
38 | .Fn ENGINE_set_flags | ||
39 | sets the flags attribute of | ||
40 | .Fa e | ||
41 | to the new | ||
42 | .Fa flags . | ||
43 | The previous state of the flags attribute is overwritten. | ||
44 | Flags that were previously set are cleared | ||
45 | unless they are also present in the new | ||
46 | .Fa flags . | ||
47 | .Pp | ||
48 | The | ||
49 | .Fa flags | ||
50 | argument can be the bitwise OR of zero or more | ||
51 | of the following constants: | ||
52 | .Bl -tag -width Ds | ||
53 | .It Dv ENGINE_FLAGS_BY_ID_COPY | ||
54 | .Xr ENGINE_by_id 3 | ||
55 | returns a shallow copy of the | ||
56 | .Vt ENGINE | ||
57 | object it found rather than incrementing the reference count | ||
58 | and returning a pointer to the original. | ||
59 | .It Dv ENGINE_FLAGS_MANUAL_CMD_CTRL | ||
60 | .Xr ENGINE_ctrl 3 | ||
61 | lets the function installed with | ||
62 | .Xr ENGINE_set_ctrl_function 3 | ||
63 | handle all commands except | ||
64 | .Dv ENGINE_CTRL_HAS_CTRL_FUNCTION , | ||
65 | even the builtin commands. | ||
66 | .It Dv ENGINE_FLAGS_NO_REGISTER_ALL | ||
67 | .Xr ENGINE_register_all_complete 3 | ||
68 | skips | ||
69 | .Fa e . | ||
70 | .El | ||
71 | .Sh RETURN VALUES | ||
72 | .Fn ENGINE_set_flags | ||
73 | always returns 1. | ||
74 | .Pp | ||
75 | .Fn ENGINE_get_flags | ||
76 | returns the | ||
77 | .Fa flags | ||
78 | attribute of | ||
79 | .Fa e . | ||