143 lines
3.7 KiB
Groff
143 lines
3.7 KiB
Groff
.\" $OpenBSD: ENGINE_register_RSA.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_REGISTER_RSA 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm ENGINE_register_RSA ,
|
|
.Nm ENGINE_register_DSA ,
|
|
.Nm ENGINE_register_ECDH ,
|
|
.Nm ENGINE_register_ECDSA ,
|
|
.Nm ENGINE_register_DH ,
|
|
.Nm ENGINE_register_RAND ,
|
|
.Nm ENGINE_register_STORE ,
|
|
.Nm ENGINE_register_ciphers ,
|
|
.Nm ENGINE_register_digests ,
|
|
.Nm ENGINE_register_complete
|
|
.Nd register an ENGINE as implementing an algorithm
|
|
.Sh SYNOPSIS
|
|
.In openssl/engine.h
|
|
.Ft int
|
|
.Fo ENGINE_register_RSA
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_DSA
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_ECDH
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_ECDSA
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_DH
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_RAND
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_STORE
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_ciphers
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_digests
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Ft int
|
|
.Fo ENGINE_register_complete
|
|
.Fa "ENGINE *e"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
In addition to the global table described in
|
|
.Xr ENGINE_add 3 ,
|
|
the crypto library maintains several tables containing references to
|
|
.Vt ENGINE
|
|
objects implementing one specific cryptographic algorithm.
|
|
.Pp
|
|
The functions listed in the present manual page append
|
|
.Fa e
|
|
to the end of the table for the respective algorithm.
|
|
.Pp
|
|
If
|
|
.Fa e
|
|
does not contain a method for the requested algorithm,
|
|
these functions succeed without having any effect.
|
|
.Pp
|
|
If
|
|
.Fa e
|
|
is already registered for the given algorithm,
|
|
they move it to the end of the respective table.
|
|
.Pp
|
|
.Fn ENGINE_register_ciphers
|
|
and
|
|
.Fn ENGINE_register_digests
|
|
are special in so far as an engine may implement
|
|
more than one cipher or more than one digest.
|
|
In that case,
|
|
.Fa e
|
|
is registered for all the ciphers or digests it implements.
|
|
.Pp
|
|
.Fn ENGINE_register_complete
|
|
registers
|
|
.Fa e
|
|
for all algorithms it implements by calling all the other functions.
|
|
.Sh RETURN VALUES
|
|
These functions return 1 on success or 0 on error.
|
|
They only fail if insufficient memory is available.
|
|
.Sh SEE ALSO
|
|
.Xr ENGINE_add 3 ,
|
|
.Xr ENGINE_get_default_RSA 3 ,
|
|
.Xr ENGINE_init 3 ,
|
|
.Xr ENGINE_new 3 ,
|
|
.Xr ENGINE_register_all_RSA 3 ,
|
|
.Xr ENGINE_set_default 3 ,
|
|
.Xr ENGINE_set_RSA 3 ,
|
|
.Xr ENGINE_unregister_RSA 3
|
|
.Sh HISTORY
|
|
.Fn ENGINE_register_RSA ,
|
|
.Fn ENGINE_register_DSA ,
|
|
.Fn ENGINE_register_DH ,
|
|
.Fn ENGINE_register_RAND ,
|
|
.Fn ENGINE_register_ciphers ,
|
|
.Fn ENGINE_register_digests ,
|
|
and
|
|
.Fn ENGINE_register_complete
|
|
first appeared in OpenSSL 0.9.7 and have been available since
|
|
.Ox 3.2 .
|
|
.Pp
|
|
.Fn ENGINE_register_ECDH ,
|
|
.Fn ENGINE_register_ECDSA ,
|
|
and
|
|
.Fn ENGINE_register_STORE
|
|
first appeared in OpenSSL 0.9.8 and have been available since
|
|
.Ox 4.5 .
|
|
.Sh BUGS
|
|
.Fn ENGINE_register_complete
|
|
ignores all errors, even memory allocation failure, and always returns 1.
|