summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2018-02-13 22:51:23 +0000
committerschwarze <>2018-02-13 22:51:23 +0000
commit4fd9c594edac4e91957a72dd64bb0bed589f8a6b (patch)
tree182a238e01b4460a025cfd16522f85fb3ea4fcd7 /src/lib
parent568784a83db25083ec71fc54554c25ec23b501da (diff)
downloadopenbsd-4fd9c594edac4e91957a72dd64bb0bed589f8a6b.tar.gz
openbsd-4fd9c594edac4e91957a72dd64bb0bed589f8a6b.tar.bz2
openbsd-4fd9c594edac4e91957a72dd64bb0bed589f8a6b.zip
Add the missing RETURN VALUES section.
Mostly from Paul Yang via OpenSSL commit 1f13ad31 Dec 25 17:50:39 2017 +0800, tweaked by me for conciseness and accuracy.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/engine.3123
1 files changed, 118 insertions, 5 deletions
diff --git a/src/lib/libcrypto/man/engine.3 b/src/lib/libcrypto/man/engine.3
index a8ef6a8951..c27c574f28 100644
--- a/src/lib/libcrypto/man/engine.3
+++ b/src/lib/libcrypto/man/engine.3
@@ -1,8 +1,10 @@
1.\" $OpenBSD: engine.3,v 1.10 2017/01/06 20:35:23 schwarze Exp $ 1.\" $OpenBSD: engine.3,v 1.11 2018/02/13 22:51:23 schwarze Exp $
2.\" OpenSSL a528d4f0 Oct 27 13:40:11 2015 -0400 2.\" full merge up to: OpenSSL crypto/engine e6390aca Jul 21 10:06:03 2015 -0400
3.\" selective merge up to: man3/ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800
3.\" 4.\"
4.\" This file was written by Geoff Thorpe <geoff@openssl.org>. 5.\" This file was written by Geoff Thorpe <geoff@openssl.org>
5.\" Copyright (c) 2002, 2004, 2007, 2015 The OpenSSL Project. 6.\" with contributions from Paul Yang <yang.yang@baishancloud.com>.
7.\" Copyright (c) 2002, 2004, 2007, 2015, 2017 The OpenSSL Project.
6.\" All rights reserved. 8.\" All rights reserved.
7.\" 9.\"
8.\" Redistribution and use in source and binary forms, with or without 10.\" Redistribution and use in source and binary forms, with or without
@@ -49,7 +51,7 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 51.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 52.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 53.\"
52.Dd $Mdocdate: January 6 2017 $ 54.Dd $Mdocdate: February 13 2018 $
53.Dt ENGINE 3 55.Dt ENGINE 3
54.Os 56.Os
55.Sh NAME 57.Sh NAME
@@ -1197,6 +1199,117 @@ to see if they implement "FOO_GET_VENDOR_LOGO_GIF" - and
1197.Vt ENGINE 1199.Vt ENGINE
1198could therefore decide whether or not to support this "foo"-specific 1200could therefore decide whether or not to support this "foo"-specific
1199extension). 1201extension).
1202.Sh RETURN VALUES
1203.Fn ENGINE_get_first ,
1204.Fn ENGINE_get_last ,
1205.Fn ENGINE_get_next ,
1206.Fn ENGINE_get_prev ,
1207.Fn ENGINE_by_id ,
1208.Fn ENGINE_get_cipher_engine ,
1209.Fn ENGINE_get_digest_engine ,
1210.Fn ENGINE_new ,
1211and all
1212.Fn ENGINE_get_default_*
1213functions return a valid
1214.Vt ENGINE
1215structure or
1216.Dv NULL
1217if an error occurred.
1218.Pp
1219.Fn ENGINE_add ,
1220.Fn ENGINE_remove ,
1221.Fn ENGINE_init ,
1222.Fn ENGINE_finish ,
1223.Fn ENGINE_ctrl_cmd ,
1224.Fn ENGINE_ctrl_cmd_string ,
1225.Fn ENGINE_free ,
1226.Fn ENGINE_up_ref ,
1227and all
1228.Fn ENGINE_set_*
1229and
1230.Fn ENGINE_register_*
1231functions return 1 on success or 0 on error.
1232.Pp
1233.Fn ENGINE_get_table_flags
1234returns an unsigned integer value representing the global table
1235flags which are used to control the registration behaviour of
1236.Vt ENGINE
1237implementations.
1238.Pp
1239For
1240.Fn ENGINE_ctrl ,
1241positive return values indicate success and negative return values
1242indicate failure.
1243The meaning of a zero return value depends on the particular
1244.Fa cmd
1245and may indicate both success and failure, which is pathetic.
1246.Pp
1247.Fn ENGINE_cmd_is_executable
1248returns 1 if
1249.Fa cmd
1250is executable or 0 otherwise.
1251.Pp
1252.Fn ENGINE_get_id
1253and
1254.Fn ENGINE_get_name
1255return a pointer to an internal string representing the identifier
1256and the name of
1257.Fa e ,
1258respectively.
1259.Pp
1260.Fn ENGINE_get_RSA ,
1261.Fn ENGINE_get_DSA ,
1262.Fn ENGINE_get_DH ,
1263.Fn ENGINE_get_RAND ,
1264and
1265.Fn ENGINE_get_STORE
1266return a method structure for the respective algorithm.
1267.Pp
1268.Fn ENGINE_get_destroy_function ,
1269.Fn ENGINE_get_init_function ,
1270.Fn ENGINE_get_finish_function ,
1271.Fn ENGINE_get_ctrl_function ,
1272.Fn ENGINE_get_load_privkey_function ,
1273.Fn ENGINE_get_load_pubkey_function ,
1274.Fn ENGINE_get_ciphers ,
1275and
1276.Fn ENGINE_get_digests
1277return a function pointer to the respective callback.
1278.Pp
1279.Fn ENGINE_get_cipher
1280returns a valid
1281.Vt EVP_CIPHER
1282structure on success or
1283.Dv NULL
1284if an error occurred.
1285.Pp
1286.Fn ENGINE_get_digest
1287returns a valid
1288.Vt EVP_MD
1289structure on success or
1290.Dv NULL
1291if an error occurred.
1292.Pp
1293.Fn ENGINE_get_flags
1294returns an integer representing the flags
1295which are used to control various behaviours of an
1296.Vt ENGINE .
1297.Pp
1298.Fn ENGINE_get_cmd_defns
1299returns an
1300.Vt ENGINE_CMD_DEFN
1301structure or
1302.Dv NULL
1303if none is set.
1304.Pp
1305.Fn ENGINE_load_private_key
1306and
1307.Fn ENGINE_load_public_key
1308return a valid
1309.Vt EVP_PKEY
1310structure on success or
1311.Dv NULL
1312if an error occurred.
1200.Sh SEE ALSO 1313.Sh SEE ALSO
1201.Xr DH_new 3 , 1314.Xr DH_new 3 ,
1202.Xr DSA_new 3 , 1315.Xr DSA_new 3 ,