92 lines
2.5 KiB
Groff
92 lines
2.5 KiB
Groff
.\" $OpenBSD: ENGINE_set_flags.3,v 1.2 2018/04/18 03:39:22 schwarze Exp $
|
|
.\" content checked up to:
|
|
.\" OpenSSL ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800
|
|
.\"
|
|
.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.Dd $Mdocdate: April 18 2018 $
|
|
.Dt ENGINE_SET_FLAGS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm ENGINE_set_flags ,
|
|
.Nm ENGINE_get_flags
|
|
.Nd modify the behaviour of an ENGINE object
|
|
.Sh SYNOPSIS
|
|
.In openssl/engine.h
|
|
.Ft int
|
|
.Fo ENGINE_set_flags
|
|
.Fa "ENGINE *e"
|
|
.Fa "int flags"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_get_flags
|
|
.Fa "const ENGINE *e"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
.Fn ENGINE_set_flags
|
|
sets the flags attribute of
|
|
.Fa e
|
|
to the new
|
|
.Fa flags .
|
|
The previous state of the flags attribute is overwritten.
|
|
Flags that were previously set are cleared
|
|
unless they are also present in the new
|
|
.Fa flags .
|
|
.Pp
|
|
The
|
|
.Fa flags
|
|
argument can be the bitwise OR of zero or more
|
|
of the following constants:
|
|
.Bl -tag -width Ds
|
|
.It Dv ENGINE_FLAGS_BY_ID_COPY
|
|
.Xr ENGINE_by_id 3
|
|
returns a shallow copy of the
|
|
.Vt ENGINE
|
|
object it found rather than incrementing the reference count
|
|
and returning a pointer to the original.
|
|
.It Dv ENGINE_FLAGS_MANUAL_CMD_CTRL
|
|
.Xr ENGINE_ctrl 3
|
|
lets the function installed with
|
|
.Xr ENGINE_set_ctrl_function 3
|
|
handle all commands except
|
|
.Dv ENGINE_CTRL_HAS_CTRL_FUNCTION ,
|
|
even the builtin commands.
|
|
.It Dv ENGINE_FLAGS_NO_REGISTER_ALL
|
|
.Xr ENGINE_register_all_complete 3
|
|
skips
|
|
.Fa e .
|
|
.El
|
|
.Sh RETURN VALUES
|
|
.Fn ENGINE_set_flags
|
|
always returns 1.
|
|
.Pp
|
|
.Fn ENGINE_get_flags
|
|
returns the
|
|
.Fa flags
|
|
attribute of
|
|
.Fa e .
|
|
.Sh SEE ALSO
|
|
.Xr ENGINE_by_id 3 ,
|
|
.Xr ENGINE_ctrl 3 ,
|
|
.Xr ENGINE_init 3 ,
|
|
.Xr ENGINE_new 3 ,
|
|
.Xr ENGINE_register_all_complete 3 ,
|
|
.Xr ENGINE_set_RSA 3
|
|
.Sh HISTORY
|
|
.Fn ENGINE_set_flags
|
|
and
|
|
.Fn ENGINE_get_flags
|
|
first appeared in OpenSSL 0.9.7 and have been available since
|
|
.Ox 3.2 .
|