You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/crypto/api/library/library.rst
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,6 +87,8 @@ See :secref:`interruptible-operations`.
87
87
.. summary::
88
88
Set the maximum number of *ops* allowed to be executed by an interruptible function in a single call.
89
89
90
+
.. versionadded:: 1.x
91
+
90
92
.. param:: uint32_t max_ops
91
93
The maximum number of ops to be executed in a single call, this can be a number from ``0`` to `PSA_IOP_MAX_OPS_UNLIMITED`, where ``0`` is obviously the least amount of work done per call.
92
94
@@ -112,6 +114,8 @@ See :secref:`interruptible-operations`.
112
114
.. summary::
113
115
Get the maximum number of *ops* allowed to be executed by an interruptible function in a single call.
114
116
117
+
.. versionadded:: 1.x
118
+
115
119
.. return:: uint32_t
116
120
Maximum number of *ops* allowed to be executed by an interruptible function in a single call.
117
121
@@ -121,7 +125,8 @@ See :secref:`interruptible-operations`.
121
125
:definition: UINT32_MAX
122
126
123
127
.. summary::
124
-
125
128
Maximum value for use with `psa_iop_set_max_ops()`.
126
129
130
+
.. versionadded:: 1.x
131
+
127
132
Using this value in a call to `psa_iop_set_max_ops()` will cause interruptible functions to complete their calculation before returning.
Copy file name to clipboardExpand all lines: doc/crypto/api/ops/signature.rst
+40Lines changed: 40 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -832,6 +832,8 @@ An interruptible asymmetric signature operation is used as follows:
832
832
.. summary::
833
833
The type of the state data structure for an interruptible asymmetric signature operation.
834
834
835
+
.. versionadded:: 1.x
836
+
835
837
Before calling any function on an interruptible asymmetric signature operation object, the application must initialize it by any of the following means:
836
838
837
839
* Set the object to all-bits-zero, for example:
@@ -868,18 +870,24 @@ An interruptible asymmetric signature operation is used as follows:
868
870
.. summary::
869
871
This macro evaluates to an initializer for an interruptible asymmetric signature operation object of type `psa_sign_iop_t`.
870
872
873
+
.. versionadded:: 1.x
874
+
871
875
.. function:: psa_sign_iop_init
872
876
873
877
.. summary::
874
878
Return an initial value for an interruptible asymmetric signature operation object.
875
879
880
+
.. versionadded:: 1.x
881
+
876
882
.. return:: psa_sign_iop_t
877
883
878
884
.. function:: psa_sign_iop_get_num_ops
879
885
880
886
.. summary::
881
887
Get the number of *ops* that an interruptible asymmetric signature operation has taken so far.
882
888
889
+
.. versionadded:: 1.x
890
+
883
891
.. param:: psa_sign_iop_t * operation
884
892
The interruptible asymmetric signature operation to inspect.
885
893
@@ -897,6 +905,8 @@ An interruptible asymmetric signature operation is used as follows:
897
905
.. summary::
898
906
Begin the setup of an interruptible asymmetric signature operation.
899
907
908
+
.. versionadded:: 1.x
909
+
900
910
.. param:: psa_sign_iop_t * operation
901
911
The interruptible asymmetric signature operation to set up. It must have been initialized as per the documentation for `psa_sign_iop_t` and not yet in use.
902
912
.. param:: psa_key_id_t key
@@ -952,6 +962,8 @@ An interruptible asymmetric signature operation is used as follows:
952
962
.. summary::
953
963
Finish setting up an interruptible asymmetric signature operation.
954
964
965
+
.. versionadded:: 1.x
966
+
955
967
.. param:: psa_sign_iop_t * operation
956
968
The interruptible asymmetric signature operation to use. The operation must be in the process of being set up.
957
969
@@ -988,6 +1000,8 @@ An interruptible asymmetric signature operation is used as follows:
988
1000
.. summary::
989
1001
Input a pre-computed hash to an interruptible asymmetric signature operation.
990
1002
1003
+
.. versionadded:: 1.x
1004
+
991
1005
.. param:: psa_sign_iop_t * operation
992
1006
The interruptible asymmetric signature operation to use. The operation must have been set up, with no data input.
993
1007
.. param:: const uint8_t * hash
@@ -1039,6 +1053,8 @@ An interruptible asymmetric signature operation is used as follows:
1039
1053
.. summary::
1040
1054
Add a message fragment to an interruptible asymmetric signature operation.
1041
1055
1056
+
.. versionadded:: 1.x
1057
+
1042
1058
.. param:: psa_sign_iop_t * operation
1043
1059
The interruptible asymmetric signature operation to use. The operation must have been set up, with no hash value input.
1044
1060
.. param:: const uint8_t * input
@@ -1091,6 +1107,8 @@ An interruptible asymmetric signature operation is used as follows:
1091
1107
.. summary::
1092
1108
Attempt to finish the interruptible calculation of an asymmetric signature.
1093
1109
1110
+
.. versionadded:: 1.x
1111
+
1094
1112
.. param:: psa_sign_iop_t * operation
1095
1113
The interruptible asymmetric signature operation to use. The operation must have hash or message data input, or be in the process of finishing.
1096
1114
.. param:: uint8_t * signature
@@ -1139,6 +1157,8 @@ An interruptible asymmetric signature operation is used as follows:
1139
1157
.. summary::
1140
1158
Abort an interruptible asymmetric signature operation.
1141
1159
1160
+
.. versionadded:: 1.x
1161
+
1142
1162
.. param:: psa_sign_iop_t * operation
1143
1163
The interruptible signature operation to abort.
1144
1164
@@ -1184,6 +1204,8 @@ An interruptible asymmetric verification operation is used as follows:
1184
1204
.. summary::
1185
1205
The type of the state data structure for an interruptible asymmetric verification operation.
1186
1206
1207
+
.. versionadded:: 1.x
1208
+
1187
1209
Before calling any function on an interruptible asymmetric verification operation object, the application must initialize it by any of the following means:
1188
1210
1189
1211
* Set the object to all-bits-zero, for example:
@@ -1220,18 +1242,24 @@ An interruptible asymmetric verification operation is used as follows:
1220
1242
.. summary::
1221
1243
This macro evaluates to an initializer for an interruptible asymmetric verification operation object of type `psa_verify_iop_t`.
1222
1244
1245
+
.. versionadded:: 1.x
1246
+
1223
1247
.. function:: psa_verify_iop_init
1224
1248
1225
1249
.. summary::
1226
1250
Return an initial value for an interruptible asymmetric verification operation object.
1227
1251
1252
+
.. versionadded:: 1.x
1253
+
1228
1254
.. return:: psa_verify_iop_t
1229
1255
1230
1256
.. function:: psa_verify_iop_get_num_ops
1231
1257
1232
1258
.. summary::
1233
1259
Get the number of *ops* that an interruptible asymmetric verification operation has taken so far.
1234
1260
1261
+
.. versionadded:: 1.x
1262
+
1235
1263
.. param:: psa_verify_iop_t * operation
1236
1264
The interruptible asymmetric verification operation to inspect.
1237
1265
@@ -1249,6 +1277,8 @@ An interruptible asymmetric verification operation is used as follows:
1249
1277
.. summary::
1250
1278
Begin the setup of an interruptible asymmetric verification operation.
1251
1279
1280
+
.. versionadded:: 1.x
1281
+
1252
1282
.. param:: psa_verify_iop_t * operation
1253
1283
The interruptible verification operation to set up. It must have been initialized as per the documentation for `psa_verify_iop_t` and not yet in use.
1254
1284
.. param:: psa_key_id_t key
@@ -1310,6 +1340,8 @@ An interruptible asymmetric verification operation is used as follows:
1310
1340
.. summary::
1311
1341
Finish setting up an interruptible asymmetric verification operation.
1312
1342
1343
+
.. versionadded:: 1.x
1344
+
1313
1345
.. param:: psa_verify_iop_t * operation
1314
1346
The interruptible verification operation to use. The operation must be in the process of being set up.
1315
1347
@@ -1347,6 +1379,8 @@ An interruptible asymmetric verification operation is used as follows:
1347
1379
.. summary::
1348
1380
Input a pre-computed hash to an interruptible asymmetric verification operation.
1349
1381
1382
+
.. versionadded:: 1.x
1383
+
1350
1384
.. param:: psa_verify_iop_t * operation
1351
1385
The interruptible verification operation to use. The operation must have been set up, with no data input.
1352
1386
.. param:: const uint8_t * hash
@@ -1398,6 +1432,8 @@ An interruptible asymmetric verification operation is used as follows:
1398
1432
.. summary::
1399
1433
Add a message fragment to an interruptible asymmetric verification operation.
1400
1434
1435
+
.. versionadded:: 1.x
1436
+
1401
1437
.. param:: psa_verify_iop_t * operation
1402
1438
The interruptible verification operation to use. The operation must have been set up, with no hash value input.
1403
1439
.. param:: const uint8_t * input
@@ -1449,6 +1485,8 @@ An interruptible asymmetric verification operation is used as follows:
1449
1485
.. summary::
1450
1486
Attempt to finish the interruptible verification of an asymmetric signature.
1451
1487
1488
+
.. versionadded:: 1.x
1489
+
1452
1490
.. param:: psa_verify_iop_t * operation
1453
1491
The interruptible verification operation to use. The operation must have hash or message data input, or be in the process of finishing.
1454
1492
@@ -1486,6 +1524,8 @@ An interruptible asymmetric verification operation is used as follows:
1486
1524
.. summary::
1487
1525
Abort an interruptible asymmetric verification operation.
1488
1526
1527
+
.. versionadded:: 1.x
1528
+
1489
1529
.. param:: psa_verify_iop_t * operation
1490
1530
The interruptible verification operation to abort.
0 commit comments