1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is last updated 4 March 2015 for version
3.5.3 of GnuTLS.
Copyright (C) 2001-2015 Free Software Foundation, Inc.\\
Copyright (C) 2001-2015 Nikos Mavrogiannopoulos
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GnuTLS 3.5.3: Abstract key API</title>
<meta name="description" content="GnuTLS 3.5.3: Abstract key API">
<meta name="keywords" content="GnuTLS 3.5.3: Abstract key API">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-and-Data-Index.html#Function-and-Data-Index" rel="index" title="Function and Data Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="API-reference.html#API-reference" rel="up" title="API reference">
<link href="Socket-specific-API.html#Socket-specific-API" rel="next" title="Socket specific API">
<link href="TPM-API.html#TPM-API" rel="prev" title="TPM API">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
body {
margin: 2%;
padding: 0 5%;
background: #ffffff;
}
h1,h2,h3,h4,h5 {
font-weight: bold;
padding: 5px 5px 5px 5px;
background-color: #c2e0ff;
color: #336699;
}
h1 {
padding: 2em 2em 2em 5%;
color: white;
background: #336699;
text-align: center;
letter-spacing: 3px;
}
h2 { text-decoration: underline; }
pre {
margin: 0 5%;
padding: 0.5em;
}
pre.example,pre.verbatim {
padding-bottom: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 1px 1px 1px 5px;
margin: 1em auto;
width: 90%;
}
div.node {
margin: 0 -5% 0 -2%;
padding: 0.5em 0.5em;
margin-top: 0.5em;
margin-bottom: 0.5em;
font-weight: bold;
}
dd, li {
padding-top: 0.1em;
padding-bottom: 0.1em;
}
div.float {
margin-bottom: 0.5em;
text-align: center;
}
table {
text-align: left;
margin-left:auto;
margin-right:auto;
border-spacing: 7px;
width: 50%;
}
th {
padding: 0;
color: #336699;
background-color: #c2e0ff;
border: solid #000000;
border-width: 0px;
margin: 1em auto;
text-align: center;
margin-left:auto;
margin-right:auto;
}
td {
padding: 0;
border: solid #000000;
background-color: #f0faff;
border-width: 0px;
margin: 1em auto;
text-align: left;
margin-left:auto;
margin-right:auto;
padding-left: 1em;
}
dl {
text-align: left;
margin-left:auto;
margin-right:auto;
width: 50%;
padding-left: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 5px 1px 1px 1px;
margin: 1em auto;
}
-->
</style>
</head>
<body lang="en">
<a name="Abstract-key-API"></a>
<div class="header">
<p>
Next: <a href="Socket-specific-API.html#Socket-specific-API" accesskey="n" rel="next">Socket specific API</a>, Previous: <a href="TPM-API.html#TPM-API" accesskey="p" rel="prev">TPM API</a>, Up: <a href="API-reference.html#API-reference" accesskey="u" rel="up">API reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Abstract-key-API-1"></a>
<h3 class="section">E.10 Abstract key API</h3>
<p>The following functions are to be used for abstract key handling.
Their prototypes lie in <samp>gnutls/abstract.h</samp>.
</p>
<a name="gnutls_005fcertificate_005fset_005fkey-1"></a>
<h4 class="subheading">gnutls_certificate_set_key</h4>
<a name="gnutls_005fcertificate_005fset_005fkey"></a><dl>
<dt><a name="index-gnutls_005fcertificate_005fset_005fkey-1"></a>Function: <em>int</em> <strong>gnutls_certificate_set_key</strong> <em>(gnutls_certificate_credentials_t <var>res</var>, const char ** <var>names</var>, int <var>names_size</var>, gnutls_pcert_st * <var>pcert_list</var>, int <var>pcert_list_size</var>, gnutls_privkey_t <var>key</var>)</em></dt>
<dd><p><var>res</var>: is a <code>gnutls_certificate_credentials_t</code> type.
</p>
<p><var>names</var>: is an array of DNS name of the certificate (NULL if none)
</p>
<p><var>names_size</var>: holds the size of the names list
</p>
<p><var>pcert_list</var>: contains a certificate list (path) for the specified private key
</p>
<p><var>pcert_list_size</var>: holds the size of the certificate list
</p>
<p><var>key</var>: is a <code>gnutls_privkey_t</code> key
</p>
<p>This function sets a certificate/private key pair in the
gnutls_certificate_credentials_t type. This function may be
called more than once, in case multiple keys/certificates exist for
the server. For clients that wants to send more than its own end
entity certificate (e.g., also an intermediate CA cert) then put
the certificate chain in <code>pcert_list</code> .
</p>
<p>Note that the <code>key</code> and the elements of <code>pcert_list</code> will become part of the credentials
structure and must not be deallocated. They will be automatically deallocated
when the <code>res</code> type is deinitialized.
</p>
<p>If that function fails to load the <code>res</code> structure is at an undefined state, it must
not be reused to load other keys or certificates.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> (0) on success, or a negative error code.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fcertificate_005fset_005fretrieve_005ffunction2-1"></a>
<h4 class="subheading">gnutls_certificate_set_retrieve_function2</h4>
<a name="gnutls_005fcertificate_005fset_005fretrieve_005ffunction2"></a><dl>
<dt><a name="index-gnutls_005fcertificate_005fset_005fretrieve_005ffunction2"></a>Function: <em>void</em> <strong>gnutls_certificate_set_retrieve_function2</strong> <em>(gnutls_certificate_credentials_t <var>cred</var>, gnutls_certificate_retrieve_function2 * <var>func</var>)</em></dt>
<dd><p><var>cred</var>: is a <code>gnutls_certificate_credentials_t</code> type.
</p>
<p><var>func</var>: is the callback function
</p>
<p>This function sets a callback to be called in order to retrieve the
certificate to be used in the handshake. The callback will take control
only if a certificate is requested by the peer.
</p>
<p>The callback’s function prototype is:
int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs,
const gnutls_pk_algorithm_t* pk_algos, int pk_algos_length, gnutls_pcert_st** pcert,
unsigned int *pcert_length, gnutls_privkey_t * pkey);
</p>
<p><code>req_ca_dn</code> is only used in X.509 certificates.
Contains a list with the CA names that the server considers trusted.
This is a hint and typically the client should send a certificate that is signed
by one of these CAs. These names, when available, are DER encoded. To get a more
meaningful value use the function <code>gnutls_x509_rdn_get()</code> .
</p>
<p><code>pk_algos</code> contains a list with server’s acceptable signature algorithms.
The certificate returned should support the server’s given algorithms.
</p>
<p><code>pcert</code> should contain a single certificate and public key or a list of them.
</p>
<p><code>pcert_length</code> is the size of the previous list.
</p>
<p><code>pkey</code> is the private key.
</p>
<p>If the callback function is provided then gnutls will call it, in the
handshake, after the certificate request message has been received.
All the provided by the callback values will not be released or
modified by gnutls.
</p>
<p>In server side pk_algos and req_ca_dn are NULL.
</p>
<p>The callback function should set the certificate list to be sent,
and return 0 on success. If no certificate was selected then the
number of certificates should be set to zero. The value (-1)
indicates error and the handshake will be terminated. If both certificates
are set in the credentials and a callback is available, the callback
takes predence.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fdeinit-1"></a>
<h4 class="subheading">gnutls_pcert_deinit</h4>
<a name="gnutls_005fpcert_005fdeinit"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fdeinit"></a>Function: <em>void</em> <strong>gnutls_pcert_deinit</strong> <em>(gnutls_pcert_st * <var>pcert</var>)</em></dt>
<dd><p><var>pcert</var>: The structure to be deinitialized
</p>
<p>This function will deinitialize a pcert structure.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fexport_005fopenpgp-1"></a>
<h4 class="subheading">gnutls_pcert_export_openpgp</h4>
<a name="gnutls_005fpcert_005fexport_005fopenpgp"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fexport_005fopenpgp"></a>Function: <em>int</em> <strong>gnutls_pcert_export_openpgp</strong> <em>(gnutls_pcert_st * <var>pcert</var>, gnutls_openpgp_crt_t * <var>crt</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure.
</p>
<p><var>crt</var>: An initialized <code>gnutls_openpgp_crt_t</code> .
</p>
<p>Converts the given <code>gnutls_pcert_t</code> type into a <code>gnutls_openpgp_crt_t</code> .
This function only works if the type of <code>pcert</code> is <code>GNUTLS_CRT_OPENPGP</code> .
When successful, the value written to <code>crt</code> must be freed with
<code>gnutls_openpgp_crt_deinit()</code> when no longer needed.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fexport_005fx509-1"></a>
<h4 class="subheading">gnutls_pcert_export_x509</h4>
<a name="gnutls_005fpcert_005fexport_005fx509"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fexport_005fx509"></a>Function: <em>int</em> <strong>gnutls_pcert_export_x509</strong> <em>(gnutls_pcert_st * <var>pcert</var>, gnutls_x509_crt_t * <var>crt</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure.
</p>
<p><var>crt</var>: An initialized <code>gnutls_x509_crt_t</code> .
</p>
<p>Converts the given <code>gnutls_pcert_t</code> type into a <code>gnutls_x509_crt_t</code> .
This function only works if the type of <code>pcert</code> is <code>GNUTLS_CRT_X509</code> .
When successful, the value written to <code>crt</code> must be freed with
<code>gnutls_x509_crt_deinit()</code> when no longer needed.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fimport_005fopenpgp-1"></a>
<h4 class="subheading">gnutls_pcert_import_openpgp</h4>
<a name="gnutls_005fpcert_005fimport_005fopenpgp"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fimport_005fopenpgp"></a>Function: <em>int</em> <strong>gnutls_pcert_import_openpgp</strong> <em>(gnutls_pcert_st * <var>pcert</var>, gnutls_openpgp_crt_t <var>crt</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure
</p>
<p><var>crt</var>: The raw certificate to be imported
</p>
<p><var>flags</var>: zero for now
</p>
<p>This convenience function will import the given certificate to a
<code>gnutls_pcert_st</code> structure. The structure must be deinitialized
afterwards using <code>gnutls_pcert_deinit()</code> ;
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fimport_005fopenpgp_005fraw-1"></a>
<h4 class="subheading">gnutls_pcert_import_openpgp_raw</h4>
<a name="gnutls_005fpcert_005fimport_005fopenpgp_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fimport_005fopenpgp_005fraw"></a>Function: <em>int</em> <strong>gnutls_pcert_import_openpgp_raw</strong> <em>(gnutls_pcert_st * <var>pcert</var>, const gnutls_datum_t * <var>cert</var>, gnutls_openpgp_crt_fmt_t <var>format</var>, gnutls_openpgp_keyid_t <var>keyid</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure
</p>
<p><var>cert</var>: The raw certificate to be imported
</p>
<p><var>format</var>: The format of the certificate
</p>
<p><var>keyid</var>: The key ID to use (NULL for the master key)
</p>
<p><var>flags</var>: zero for now
</p>
<p>This convenience function will import the given certificate to a
<code>gnutls_pcert_st</code> structure. The structure must be deinitialized
afterwards using <code>gnutls_pcert_deinit()</code> ;
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fimport_005fx509-1"></a>
<h4 class="subheading">gnutls_pcert_import_x509</h4>
<a name="gnutls_005fpcert_005fimport_005fx509"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fimport_005fx509"></a>Function: <em>int</em> <strong>gnutls_pcert_import_x509</strong> <em>(gnutls_pcert_st * <var>pcert</var>, gnutls_x509_crt_t <var>crt</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure
</p>
<p><var>crt</var>: The certificate to be imported
</p>
<p><var>flags</var>: zero for now
</p>
<p>This convenience function will import the given certificate to a
<code>gnutls_pcert_st</code> structure. The structure must be deinitialized
afterwards using <code>gnutls_pcert_deinit()</code> ;
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fimport_005fx509_005flist-1"></a>
<h4 class="subheading">gnutls_pcert_import_x509_list</h4>
<a name="gnutls_005fpcert_005fimport_005fx509_005flist"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fimport_005fx509_005flist"></a>Function: <em>int</em> <strong>gnutls_pcert_import_x509_list</strong> <em>(gnutls_pcert_st * <var>pcert</var>, gnutls_x509_crt_t * <var>crt</var>, unsigned * <var>ncrt</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure
</p>
<p><var>crt</var>: The certificates to be imported
</p>
<p><var>ncrt</var>: The number of certificates
</p>
<p><var>flags</var>: zero or <code>GNUTLS_X509_CRT_LIST_SORT</code>
</p>
<p>This convenience function will import the given certificate to a
<code>gnutls_pcert_st</code> structure. The structure must be deinitialized
afterwards using <code>gnutls_pcert_deinit()</code> ;
</p>
<p>In the case <code>GNUTLS_X509_CRT_LIST_SORT</code> is specified and that
function cannot sort the list, <code>GNUTLS_E_CERTIFICATE_LIST_UNSORTED</code>
will be returned. Currently sorting can fail if the list size
exceeds an internal constraint (16).
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fpcert_005fimport_005fx509_005fraw-1"></a>
<h4 class="subheading">gnutls_pcert_import_x509_raw</h4>
<a name="gnutls_005fpcert_005fimport_005fx509_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpcert_005fimport_005fx509_005fraw"></a>Function: <em>int</em> <strong>gnutls_pcert_import_x509_raw</strong> <em>(gnutls_pcert_st * <var>pcert</var>, const gnutls_datum_t * <var>cert</var>, gnutls_x509_crt_fmt_t <var>format</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcert</var>: The pcert structure
</p>
<p><var>cert</var>: The raw certificate to be imported
</p>
<p><var>format</var>: The format of the certificate
</p>
<p><var>flags</var>: zero for now
</p>
<p>This convenience function will import the given certificate to a
<code>gnutls_pcert_st</code> structure. The structure must be deinitialized
afterwards using <code>gnutls_pcert_deinit()</code> ;
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpcert_005flist_005fimport_005fx509_005fraw-1"></a>
<h4 class="subheading">gnutls_pcert_list_import_x509_raw</h4>
<a name="gnutls_005fpcert_005flist_005fimport_005fx509_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpcert_005flist_005fimport_005fx509_005fraw"></a>Function: <em>int</em> <strong>gnutls_pcert_list_import_x509_raw</strong> <em>(gnutls_pcert_st * <var>pcerts</var>, unsigned int * <var>pcert_max</var>, const gnutls_datum_t * <var>data</var>, gnutls_x509_crt_fmt_t <var>format</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pcerts</var>: The structures to store the parsed certificate. Must not be initialized.
</p>
<p><var>pcert_max</var>: Initially must hold the maximum number of certs. It will be updated with the number of certs available.
</p>
<p><var>data</var>: The certificates.
</p>
<p><var>format</var>: One of DER or PEM.
</p>
<p><var>flags</var>: must be (0) or an OR’d sequence of gnutls_certificate_import_flags.
</p>
<p>This function will convert the given PEM encoded certificate list
to the native gnutls_x509_crt_t format. The output will be stored
in <code>certs</code> . They will be automatically initialized.
</p>
<p>If the Certificate is PEM encoded it should have a header of "X509
CERTIFICATE", or "CERTIFICATE".
</p>
<p><strong>Returns:</strong> the number of certificates read or a negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fdecrypt_005fdata-1"></a>
<h4 class="subheading">gnutls_privkey_decrypt_data</h4>
<a name="gnutls_005fprivkey_005fdecrypt_005fdata"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fdecrypt_005fdata-1"></a>Function: <em>int</em> <strong>gnutls_privkey_decrypt_data</strong> <em>(gnutls_privkey_t <var>key</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>ciphertext</var>, gnutls_datum_t * <var>plaintext</var>)</em></dt>
<dd><p><var>key</var>: Holds the key
</p>
<p><var>flags</var>: zero for now
</p>
<p><var>ciphertext</var>: holds the data to be decrypted
</p>
<p><var>plaintext</var>: will contain the decrypted data, allocated with <code>gnutls_malloc()</code>
</p>
<p>This function will decrypt the given data using the algorithm
supported by the private key.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fdeinit-1"></a>
<h4 class="subheading">gnutls_privkey_deinit</h4>
<a name="gnutls_005fprivkey_005fdeinit"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fdeinit"></a>Function: <em>void</em> <strong>gnutls_privkey_deinit</strong> <em>(gnutls_privkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: The key to be deinitialized
</p>
<p>This function will deinitialize a private key structure.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005fdsa_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_export_dsa_raw</h4>
<a name="gnutls_005fprivkey_005fexport_005fdsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005fdsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_export_dsa_raw</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_datum_t * <var>p</var>, gnutls_datum_t * <var>q</var>, gnutls_datum_t * <var>g</var>, gnutls_datum_t * <var>y</var>, gnutls_datum_t * <var>x</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>p</var>: will hold the p
</p>
<p><var>q</var>: will hold the q
</p>
<p><var>g</var>: will hold the g
</p>
<p><var>y</var>: will hold the y
</p>
<p><var>x</var>: will hold the x
</p>
<p>This function will export the DSA private key’s parameters found
in the given structure. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005fecc_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_export_ecc_raw</h4>
<a name="gnutls_005fprivkey_005fexport_005fecc_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005fecc_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_export_ecc_raw</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_ecc_curve_t * <var>curve</var>, gnutls_datum_t * <var>x</var>, gnutls_datum_t * <var>y</var>, gnutls_datum_t * <var>k</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>curve</var>: will hold the curve
</p>
<p><var>x</var>: will hold the x coordinate
</p>
<p><var>y</var>: will hold the y coordinate
</p>
<p><var>k</var>: will hold the private key
</p>
<p>This function will export the ECC private key’s parameters found
in the given structure. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005fopenpgp-1"></a>
<h4 class="subheading">gnutls_privkey_export_openpgp</h4>
<a name="gnutls_005fprivkey_005fexport_005fopenpgp"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005fopenpgp"></a>Function: <em>int</em> <strong>gnutls_privkey_export_openpgp</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_openpgp_privkey_t * <var>key</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: Location for the key to be exported.
</p>
<p>Converts the given abstract private key to a <code>gnutls_openpgp_privkey_t</code>
type. The key must be of type <code>GNUTLS_PRIVKEY_OPENPGP</code> . The key
returned in <code>key</code> must be deinitialized with
<code>gnutls_openpgp_privkey_deinit()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005fpkcs11-1"></a>
<h4 class="subheading">gnutls_privkey_export_pkcs11</h4>
<a name="gnutls_005fprivkey_005fexport_005fpkcs11"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005fpkcs11"></a>Function: <em>int</em> <strong>gnutls_privkey_export_pkcs11</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pkcs11_privkey_t * <var>key</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: Location for the key to be exported.
</p>
<p>Converts the given abstract private key to a <code>gnutls_pkcs11_privkey_t</code>
type. The key must be of type <code>GNUTLS_PRIVKEY_PKCS11</code> . The key
returned in <code>key</code> must be deinitialized with
<code>gnutls_pkcs11_privkey_deinit()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005frsa_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_export_rsa_raw</h4>
<a name="gnutls_005fprivkey_005fexport_005frsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005frsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_export_rsa_raw</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_datum_t * <var>m</var>, gnutls_datum_t * <var>e</var>, gnutls_datum_t * <var>d</var>, gnutls_datum_t * <var>p</var>, gnutls_datum_t * <var>q</var>, gnutls_datum_t * <var>u</var>, gnutls_datum_t * <var>e1</var>, gnutls_datum_t * <var>e2</var>)</em></dt>
<dd><p><var>key</var>: Holds the certificate
</p>
<p><var>m</var>: will hold the modulus
</p>
<p><var>e</var>: will hold the public exponent
</p>
<p><var>d</var>: will hold the private exponent
</p>
<p><var>p</var>: will hold the first prime (p)
</p>
<p><var>q</var>: will hold the second prime (q)
</p>
<p><var>u</var>: will hold the coefficient
</p>
<p><var>e1</var>: will hold e1 = d mod (p-1)
</p>
<p><var>e2</var>: will hold e2 = d mod (q-1)
</p>
<p>This function will export the RSA private key’s parameters found
in the given structure. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fexport_005fx509-1"></a>
<h4 class="subheading">gnutls_privkey_export_x509</h4>
<a name="gnutls_005fprivkey_005fexport_005fx509"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fexport_005fx509"></a>Function: <em>int</em> <strong>gnutls_privkey_export_x509</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_x509_privkey_t * <var>key</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: Location for the key to be exported.
</p>
<p>Converts the given abstract private key to a <code>gnutls_x509_privkey_t</code>
type. The key must be of type <code>GNUTLS_PRIVKEY_X509</code> . The key returned
in <code>key</code> must be deinitialized with <code>gnutls_x509_privkey_deinit()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fgenerate-1"></a>
<h4 class="subheading">gnutls_privkey_generate</h4>
<a name="gnutls_005fprivkey_005fgenerate"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fgenerate"></a>Function: <em>int</em> <strong>gnutls_privkey_generate</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pk_algorithm_t <var>algo</var>, unsigned int <var>bits</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: An initialized private key
</p>
<p><var>algo</var>: is one of the algorithms in <code>gnutls_pk_algorithm_t</code> .
</p>
<p><var>bits</var>: the size of the parameters to generate
</p>
<p><var>flags</var>: Must be zero or flags from <code>gnutls_privkey_flags_t</code> .
</p>
<p>This function will generate a random private key. Note that this
function must be called on an empty private key. The flag <code>GNUTLS_PRIVKEY_FLAG_PROVABLE</code>
instructs the key generation process to use algorithms which generate
provable parameters out of a seed.
</p>
<p>Note that when generating an elliptic curve key, the curve
can be substituted in the place of the bits parameter using the
<code>GNUTLS_CURVE_TO_BITS()</code> macro. The input to the macro is any curve from
<code>gnutls_ecc_curve_t</code> .
</p>
<p>For DSA keys, if the subgroup size needs to be specified check
the <code>GNUTLS_SUBGROUP_TO_BITS()</code> macro.
</p>
<p>It is recommended to do not set the number of <code>bits</code> directly, use <code>gnutls_sec_param_to_pk_bits()</code> instead .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fgenerate2-1"></a>
<h4 class="subheading">gnutls_privkey_generate2</h4>
<a name="gnutls_005fprivkey_005fgenerate2"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fgenerate2"></a>Function: <em>int</em> <strong>gnutls_privkey_generate2</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pk_algorithm_t <var>algo</var>, unsigned int <var>bits</var>, unsigned int <var>flags</var>, const gnutls_keygen_data_st * <var>data</var>, unsigned <var>data_size</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>algo</var>: is one of the algorithms in <code>gnutls_pk_algorithm_t</code> .
</p>
<p><var>bits</var>: the size of the modulus
</p>
<p><var>flags</var>: Must be zero or flags from <code>gnutls_privkey_flags_t</code> .
</p>
<p><var>data</var>: Allow specifying <code>gnutls_keygen_data_st</code> types such as the seed to be used.
</p>
<p><var>data_size</var>: The number of <code>data</code> available.
</p>
<p>This function will generate a random private key. Note that this
function must be called on an empty private key. The flag <code>GNUTLS_PRIVKEY_FLAG_PROVABLE</code>
instructs the key generation process to use algorithms like Shawe-Taylor
which generate provable parameters out of a seed.
</p>
<p>Note that when generating an elliptic curve key, the curve
can be substituted in the place of the bits parameter using the
<code>GNUTLS_CURVE_TO_BITS()</code> macro.
</p>
<p>Do not set the number of bits directly, use <code>gnutls_sec_param_to_pk_bits()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.5.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fget_005fpk_005falgorithm-1"></a>
<h4 class="subheading">gnutls_privkey_get_pk_algorithm</h4>
<a name="gnutls_005fprivkey_005fget_005fpk_005falgorithm"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fget_005fpk_005falgorithm"></a>Function: <em>int</em> <strong>gnutls_privkey_get_pk_algorithm</strong> <em>(gnutls_privkey_t <var>key</var>, unsigned int * <var>bits</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_privkey_t</code> type
</p>
<p><var>bits</var>: If set will return the number of bits of the parameters (may be NULL)
</p>
<p>This function will return the public key algorithm of a private
key and if possible will return a number of bits that indicates
the security parameter of the key.
</p>
<p><strong>Returns:</strong> a member of the <code>gnutls_pk_algorithm_t</code> enumeration on
success, or a negative error code on error.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fget_005fseed-1"></a>
<h4 class="subheading">gnutls_privkey_get_seed</h4>
<a name="gnutls_005fprivkey_005fget_005fseed"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fget_005fseed"></a>Function: <em>int</em> <strong>gnutls_privkey_get_seed</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_digest_algorithm_t * <var>digest</var>, void * <var>seed</var>, size_t * <var>seed_size</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_privkey_t</code> type
</p>
<p><var>digest</var>: if non-NULL it will contain the digest algorithm used for key generation (if applicable)
</p>
<p><var>seed</var>: where seed will be copied to
</p>
<p><var>seed_size</var>: originally holds the size of <code>seed</code> , will be updated with actual size
</p>
<p>This function will return the seed that was used to generate the
given private key. That function will succeed only if the key was generated
as a provable key.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.5.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fget_005ftype-1"></a>
<h4 class="subheading">gnutls_privkey_get_type</h4>
<a name="gnutls_005fprivkey_005fget_005ftype"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fget_005ftype"></a>Function: <em>gnutls_privkey_type_t</em> <strong>gnutls_privkey_get_type</strong> <em>(gnutls_privkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_privkey_t</code> type
</p>
<p>This function will return the type of the private key. This is
actually the type of the subsystem used to set this private key.
</p>
<p><strong>Returns:</strong> a member of the <code>gnutls_privkey_type_t</code> enumeration on
success, or a negative error code on error.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fdsa_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_dsa_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005fdsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fdsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_import_dsa_raw</strong> <em>(gnutls_privkey_t <var>key</var>, const gnutls_datum_t * <var>p</var>, const gnutls_datum_t * <var>q</var>, const gnutls_datum_t * <var>g</var>, const gnutls_datum_t * <var>y</var>, const gnutls_datum_t * <var>x</var>)</em></dt>
<dd><p><var>key</var>: The structure to store the parsed key
</p>
<p><var>p</var>: holds the p
</p>
<p><var>q</var>: holds the q
</p>
<p><var>g</var>: holds the g
</p>
<p><var>y</var>: holds the y
</p>
<p><var>x</var>: holds the x
</p>
<p>This function will convert the given DSA raw parameters to the
native <code>gnutls_privkey_t</code> format. The output will be stored
in <code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fecc_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_ecc_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005fecc_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fecc_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_import_ecc_raw</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_ecc_curve_t <var>curve</var>, const gnutls_datum_t * <var>x</var>, const gnutls_datum_t * <var>y</var>, const gnutls_datum_t * <var>k</var>)</em></dt>
<dd><p><var>key</var>: The key
</p>
<p><var>curve</var>: holds the curve
</p>
<p><var>x</var>: holds the x
</p>
<p><var>y</var>: holds the y
</p>
<p><var>k</var>: holds the k
</p>
<p>This function will convert the given elliptic curve parameters to the
native <code>gnutls_privkey_t</code> format. The output will be stored
in <code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fext-1"></a>
<h4 class="subheading">gnutls_privkey_import_ext</h4>
<a name="gnutls_005fprivkey_005fimport_005fext"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fext"></a>Function: <em>int</em> <strong>gnutls_privkey_import_ext</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pk_algorithm_t <var>pk</var>, void * <var>userdata</var>, gnutls_privkey_sign_func <var>sign_func</var>, gnutls_privkey_decrypt_func <var>decrypt_func</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>pk</var>: The public key algorithm
</p>
<p><var>userdata</var>: private data to be provided to the callbacks
</p>
<p><var>sign_func</var>: callback for signature operations
</p>
<p><var>decrypt_func</var>: callback for decryption operations
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will associate the given callbacks with the
<code>gnutls_privkey_t</code> type. At least one of the two callbacks
must be non-null.
</p>
<p>Note that the signing function is supposed to "raw" sign data, i.e.,
without any hashing or preprocessing. In case of RSA the DigestInfo
will be provided, and the signing function is expected to do the PKCS <code>1</code>
1.5 padding and the exponentiation.
</p>
<p>See also <code>gnutls_privkey_import_ext3()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fext2-1"></a>
<h4 class="subheading">gnutls_privkey_import_ext2</h4>
<a name="gnutls_005fprivkey_005fimport_005fext2"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fext2"></a>Function: <em>int</em> <strong>gnutls_privkey_import_ext2</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pk_algorithm_t <var>pk</var>, void * <var>userdata</var>, gnutls_privkey_sign_func <var>sign_fn</var>, gnutls_privkey_decrypt_func <var>decrypt_fn</var>, gnutls_privkey_deinit_func <var>deinit_fn</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>pk</var>: The public key algorithm
</p>
<p><var>userdata</var>: private data to be provided to the callbacks
</p>
<p><var>sign_fn</var>: callback for signature operations
</p>
<p><var>decrypt_fn</var>: callback for decryption operations
</p>
<p><var>deinit_fn</var>: a deinitialization function
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will associate the given callbacks with the
<code>gnutls_privkey_t</code> type. At least one of the two callbacks
must be non-null. If a deinitialization function is provided
then flags is assumed to contain <code>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code> .
</p>
<p>Note that the signing function is supposed to "raw" sign data, i.e.,
without any hashing or preprocessing. In case of RSA the DigestInfo
will be provided, and the signing function is expected to do the PKCS <code>1</code>
1.5 padding and the exponentiation.
</p>
<p>See also <code>gnutls_privkey_import_ext3()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fext3-1"></a>
<h4 class="subheading">gnutls_privkey_import_ext3</h4>
<a name="gnutls_005fprivkey_005fimport_005fext3"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fext3-1"></a>Function: <em>int</em> <strong>gnutls_privkey_import_ext3</strong> <em>(gnutls_privkey_t <var>pkey</var>, void * <var>userdata</var>, gnutls_privkey_sign_func <var>sign_fn</var>, gnutls_privkey_decrypt_func <var>decrypt_fn</var>, gnutls_privkey_deinit_func <var>deinit_fn</var>, gnutls_privkey_info_func <var>info_fn</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>userdata</var>: private data to be provided to the callbacks
</p>
<p><var>sign_fn</var>: callback for signature operations
</p>
<p><var>decrypt_fn</var>: callback for decryption operations
</p>
<p><var>deinit_fn</var>: a deinitialization function
</p>
<p><var>info_fn</var>: returns info about the public key algorithm (should not be <code>NULL</code> )
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will associate the given callbacks with the
<code>gnutls_privkey_t</code> type. At least one of the two callbacks
must be non-null. If a deinitialization function is provided
then flags is assumed to contain <code>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code> .
</p>
<p>Note that the signing function is supposed to "raw" sign data, i.e.,
without any hashing or preprocessing. In case of RSA the DigestInfo
will be provided, and the signing function is expected to do the PKCS <code>1</code>
1.5 padding and the exponentiation.
</p>
<p>The <code>info_fn</code> must provide information on the algorithms supported by
this private key, and should support the flags <code>GNUTLS_PRIVKEY_INFO_PK_ALGO</code> and
<code>GNUTLS_PRIVKEY_INFO_SIGN_ALGO</code> . It must return -1 on unknown flags.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fopenpgp-1"></a>
<h4 class="subheading">gnutls_privkey_import_openpgp</h4>
<a name="gnutls_005fprivkey_005fimport_005fopenpgp"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fopenpgp"></a>Function: <em>int</em> <strong>gnutls_privkey_import_openpgp</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_openpgp_privkey_t <var>key</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: The private key to be imported
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>The <code>gnutls_openpgp_privkey_t</code> object must not be deallocated
during the lifetime of this structure. The subkey set as
preferred will be used, or the master key otherwise.
</p>
<p><code>flags</code> might be zero or one of <code>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code>
and <code>GNUTLS_PRIVKEY_IMPORT_COPY</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fopenpgp_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_openpgp_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005fopenpgp_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fopenpgp_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_import_openpgp_raw</strong> <em>(gnutls_privkey_t <var>pkey</var>, const gnutls_datum_t * <var>data</var>, gnutls_openpgp_crt_fmt_t <var>format</var>, const gnutls_openpgp_keyid_t <var>keyid</var>, const char * <var>password</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>data</var>: The private key data to be imported
</p>
<p><var>format</var>: The format of the private key
</p>
<p><var>keyid</var>: The key id to use (optional)
</p>
<p><var>password</var>: A password (optional)
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fpkcs11-1"></a>
<h4 class="subheading">gnutls_privkey_import_pkcs11</h4>
<a name="gnutls_005fprivkey_005fimport_005fpkcs11"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fpkcs11"></a>Function: <em>int</em> <strong>gnutls_privkey_import_pkcs11</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_pkcs11_privkey_t <var>key</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: The private key to be imported
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>The <code>gnutls_pkcs11_privkey_t</code> object must not be deallocated
during the lifetime of this structure.
</p>
<p><code>flags</code> might be zero or one of <code>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code>
and <code>GNUTLS_PRIVKEY_IMPORT_COPY</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fpkcs11_005furl-1"></a>
<h4 class="subheading">gnutls_privkey_import_pkcs11_url</h4>
<a name="gnutls_005fprivkey_005fimport_005fpkcs11_005furl"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fpkcs11_005furl"></a>Function: <em>int</em> <strong>gnutls_privkey_import_pkcs11_url</strong> <em>(gnutls_privkey_t <var>key</var>, const char * <var>url</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_pubkey_t</code>
</p>
<p><var>url</var>: A PKCS 11 url
</p>
<p>This function will import a PKCS 11 private key to a <code>gnutls_private_key_t</code>
type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005frsa_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_rsa_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005frsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005frsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_import_rsa_raw</strong> <em>(gnutls_privkey_t <var>key</var>, const gnutls_datum_t * <var>m</var>, const gnutls_datum_t * <var>e</var>, const gnutls_datum_t * <var>d</var>, const gnutls_datum_t * <var>p</var>, const gnutls_datum_t * <var>q</var>, const gnutls_datum_t * <var>u</var>, const gnutls_datum_t * <var>e1</var>, const gnutls_datum_t * <var>e2</var>)</em></dt>
<dd><p><var>key</var>: The structure to store the parsed key
</p>
<p><var>m</var>: holds the modulus
</p>
<p><var>e</var>: holds the public exponent
</p>
<p><var>d</var>: holds the private exponent
</p>
<p><var>p</var>: holds the first prime (p)
</p>
<p><var>q</var>: holds the second prime (q)
</p>
<p><var>u</var>: holds the coefficient (optional)
</p>
<p><var>e1</var>: holds e1 = d mod (p-1) (optional)
</p>
<p><var>e2</var>: holds e2 = d mod (q-1) (optional)
</p>
<p>This function will convert the given RSA raw parameters to the
native <code>gnutls_privkey_t</code> format. The output will be stored in
<code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005ftpm_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_tpm_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005ftpm_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005ftpm_005fraw"></a>Function: <em>int</em> <strong>gnutls_privkey_import_tpm_raw</strong> <em>(gnutls_privkey_t <var>pkey</var>, const gnutls_datum_t * <var>fdata</var>, gnutls_tpmkey_fmt_t <var>format</var>, const char * <var>srk_password</var>, const char * <var>key_password</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>fdata</var>: The TPM key to be imported
</p>
<p><var>format</var>: The format of the private key
</p>
<p><var>srk_password</var>: The password for the SRK key (optional)
</p>
<p><var>key_password</var>: A password for the key (optional)
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>With respect to passwords the same as in <code>gnutls_privkey_import_tpm_url()</code> apply.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005ftpm_005furl-1"></a>
<h4 class="subheading">gnutls_privkey_import_tpm_url</h4>
<a name="gnutls_005fprivkey_005fimport_005ftpm_005furl"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005ftpm_005furl-1"></a>Function: <em>int</em> <strong>gnutls_privkey_import_tpm_url</strong> <em>(gnutls_privkey_t <var>pkey</var>, const char * <var>url</var>, const char * <var>srk_password</var>, const char * <var>key_password</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>url</var>: The URL of the TPM key to be imported
</p>
<p><var>srk_password</var>: The password for the SRK key (optional)
</p>
<p><var>key_password</var>: A password for the key (optional)
</p>
<p><var>flags</var>: One of the GNUTLS_PRIVKEY_* flags
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>Note that unless <code>GNUTLS_PRIVKEY_DISABLE_CALLBACKS</code>
is specified, if incorrect (or NULL) passwords are given
the PKCS11 callback functions will be used to obtain the
correct passwords. Otherwise if the SRK password is wrong
<code>GNUTLS_E_TPM_SRK_PASSWORD_ERROR</code> is returned and if the key password
is wrong or not provided then <code>GNUTLS_E_TPM_KEY_PASSWORD_ERROR</code>
is returned.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005furl-1"></a>
<h4 class="subheading">gnutls_privkey_import_url</h4>
<a name="gnutls_005fprivkey_005fimport_005furl"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005furl-1"></a>Function: <em>int</em> <strong>gnutls_privkey_import_url</strong> <em>(gnutls_privkey_t <var>key</var>, const char * <var>url</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_privkey_t</code>
</p>
<p><var>url</var>: A PKCS 11 url
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import a PKCS11 or TPM URL as a
private key. The supported URL types can be checked
using <code>gnutls_url_is_supported()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fx509-1"></a>
<h4 class="subheading">gnutls_privkey_import_x509</h4>
<a name="gnutls_005fprivkey_005fimport_005fx509"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fx509"></a>Function: <em>int</em> <strong>gnutls_privkey_import_x509</strong> <em>(gnutls_privkey_t <var>pkey</var>, gnutls_x509_privkey_t <var>key</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>key</var>: The private key to be imported
</p>
<p><var>flags</var>: Flags for the import
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>The <code>gnutls_x509_privkey_t</code> object must not be deallocated
during the lifetime of this structure.
</p>
<p><code>flags</code> might be zero or one of <code>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code>
and <code>GNUTLS_PRIVKEY_IMPORT_COPY</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fimport_005fx509_005fraw-1"></a>
<h4 class="subheading">gnutls_privkey_import_x509_raw</h4>
<a name="gnutls_005fprivkey_005fimport_005fx509_005fraw"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fimport_005fx509_005fraw-1"></a>Function: <em>int</em> <strong>gnutls_privkey_import_x509_raw</strong> <em>(gnutls_privkey_t <var>pkey</var>, const gnutls_datum_t * <var>data</var>, gnutls_x509_crt_fmt_t <var>format</var>, const char * <var>password</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The private key
</p>
<p><var>data</var>: The private key data to be imported
</p>
<p><var>format</var>: The format of the private key
</p>
<p><var>password</var>: A password (optional)
</p>
<p><var>flags</var>: an ORed sequence of gnutls_pkcs_encrypt_flags_t
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>The supported formats are basic unencrypted key, PKCS8, PKCS12,
and the openssl format.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005finit-1"></a>
<h4 class="subheading">gnutls_privkey_init</h4>
<a name="gnutls_005fprivkey_005finit"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005finit"></a>Function: <em>int</em> <strong>gnutls_privkey_init</strong> <em>(gnutls_privkey_t * <var>key</var>)</em></dt>
<dd><p><var>key</var>: A pointer to the type to be initialized
</p>
<p>This function will initialize a private key.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fset_005fflags-1"></a>
<h4 class="subheading">gnutls_privkey_set_flags</h4>
<a name="gnutls_005fprivkey_005fset_005fflags"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fset_005fflags"></a>Function: <em>void</em> <strong>gnutls_privkey_set_flags</strong> <em>(gnutls_privkey_t <var>key</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_privkey_t</code>
</p>
<p><var>flags</var>: flags from the <code>gnutls_privkey_flags</code>
</p>
<p>This function will set flags for the specified private key, after
it is generated. Currently this is useful for the <code>GNUTLS_PRIVKEY_FLAG_EXPORT_COMPAT</code>
to allow exporting a "provable" private key in backwards compatible way.
</p>
<p><strong>Since:</strong> 3.5.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fset_005fpin_005ffunction-1"></a>
<h4 class="subheading">gnutls_privkey_set_pin_function</h4>
<a name="gnutls_005fprivkey_005fset_005fpin_005ffunction"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fset_005fpin_005ffunction"></a>Function: <em>void</em> <strong>gnutls_privkey_set_pin_function</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_pin_callback_t <var>fn</var>, void * <var>userdata</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_privkey_t</code>
</p>
<p><var>fn</var>: the callback
</p>
<p><var>userdata</var>: data associated with the callback
</p>
<p>This function will set a callback function to be used when
required to access the object. This function overrides any other
global PIN functions.
</p>
<p>Note that this function must be called right after initialization
to have effect.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fsign_005fdata-1"></a>
<h4 class="subheading">gnutls_privkey_sign_data</h4>
<a name="gnutls_005fprivkey_005fsign_005fdata"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fsign_005fdata-1"></a>Function: <em>int</em> <strong>gnutls_privkey_sign_data</strong> <em>(gnutls_privkey_t <var>signer</var>, gnutls_digest_algorithm_t <var>hash</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>data</var>, gnutls_datum_t * <var>signature</var>)</em></dt>
<dd><p><var>signer</var>: Holds the key
</p>
<p><var>hash</var>: should be a digest algorithm
</p>
<p><var>flags</var>: Zero or one of <code>gnutls_privkey_flags_t</code>
</p>
<p><var>data</var>: holds the data to be signed
</p>
<p><var>signature</var>: will contain the signature allocated with <code>gnutls_malloc()</code>
</p>
<p>This function will sign the given data using a signature algorithm
supported by the private key. Signature algorithms are always used
together with a hash functions. Different hash functions may be
used for the RSA algorithm, but only the SHA family for the DSA keys.
</p>
<p>You may use <code>gnutls_pubkey_get_preferred_hash_algorithm()</code> to determine
the hash algorithm.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fsign_005fhash-1"></a>
<h4 class="subheading">gnutls_privkey_sign_hash</h4>
<a name="gnutls_005fprivkey_005fsign_005fhash"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fsign_005fhash-1"></a>Function: <em>int</em> <strong>gnutls_privkey_sign_hash</strong> <em>(gnutls_privkey_t <var>signer</var>, gnutls_digest_algorithm_t <var>hash_algo</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>hash_data</var>, gnutls_datum_t * <var>signature</var>)</em></dt>
<dd><p><var>signer</var>: Holds the signer’s key
</p>
<p><var>hash_algo</var>: The hash algorithm used
</p>
<p><var>flags</var>: Zero or one of <code>gnutls_privkey_flags_t</code>
</p>
<p><var>hash_data</var>: holds the data to be signed
</p>
<p><var>signature</var>: will contain newly allocated signature
</p>
<p>This function will sign the given hashed data using a signature algorithm
supported by the private key. Signature algorithms are always used
together with a hash functions. Different hash functions may be
used for the RSA algorithm, but only SHA-XXX for the DSA keys.
</p>
<p>You may use <code>gnutls_pubkey_get_preferred_hash_algorithm()</code> to determine
the hash algorithm.
</p>
<p>Note that if <code>GNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA</code> flag is specified this function
will ignore <code>hash_algo</code> and perform a raw PKCS1 signature.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fstatus-1"></a>
<h4 class="subheading">gnutls_privkey_status</h4>
<a name="gnutls_005fprivkey_005fstatus"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fstatus"></a>Function: <em>int</em> <strong>gnutls_privkey_status</strong> <em>(gnutls_privkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: Holds the key
</p>
<p>Checks the status of the private key token. This function
is an actual wrapper over <code>gnutls_pkcs11_privkey_status()</code> , and
if the private key is a PKCS <code>11</code> token it will check whether
it is inserted or not.
</p>
<p><strong>Returns:</strong> this function will return non-zero if the token
holding the private key is still available (inserted), and zero otherwise.
</p>
<p><strong>Since:</strong> 3.1.10
</p></dd></dl>
<a name="gnutls_005fprivkey_005fverify_005fparams-1"></a>
<h4 class="subheading">gnutls_privkey_verify_params</h4>
<a name="gnutls_005fprivkey_005fverify_005fparams"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fverify_005fparams"></a>Function: <em>int</em> <strong>gnutls_privkey_verify_params</strong> <em>(gnutls_privkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_privkey_t</code> type
</p>
<p>This function will verify the private key parameters.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fprivkey_005fverify_005fseed-1"></a>
<h4 class="subheading">gnutls_privkey_verify_seed</h4>
<a name="gnutls_005fprivkey_005fverify_005fseed"></a><dl>
<dt><a name="index-gnutls_005fprivkey_005fverify_005fseed"></a>Function: <em>int</em> <strong>gnutls_privkey_verify_seed</strong> <em>(gnutls_privkey_t <var>key</var>, gnutls_digest_algorithm_t <var>digest</var>, const void * <var>seed</var>, size_t <var>seed_size</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_privkey_t</code> type
</p>
<p><var>digest</var>: it contains the digest algorithm used for key generation (if applicable)
</p>
<p><var>seed</var>: the seed of the key to be checked with
</p>
<p><var>seed_size</var>: holds the size of <code>seed</code>
</p>
<p>This function will verify that the given private key was generated from
the provided seed.
</p>
<p><strong>Returns:</strong> In case of a verification failure <code>GNUTLS_E_PRIVKEY_VERIFICATION_ERROR</code>
is returned, and zero or positive code on success.
</p>
<p><strong>Since:</strong> 3.5.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fdeinit-1"></a>
<h4 class="subheading">gnutls_pubkey_deinit</h4>
<a name="gnutls_005fpubkey_005fdeinit"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fdeinit"></a>Function: <em>void</em> <strong>gnutls_pubkey_deinit</strong> <em>(gnutls_pubkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: The key to be deinitialized
</p>
<p>This function will deinitialize a public key structure.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fencrypt_005fdata-1"></a>
<h4 class="subheading">gnutls_pubkey_encrypt_data</h4>
<a name="gnutls_005fpubkey_005fencrypt_005fdata"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fencrypt_005fdata-1"></a>Function: <em>int</em> <strong>gnutls_pubkey_encrypt_data</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>plaintext</var>, gnutls_datum_t * <var>ciphertext</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>flags</var>: should be 0 for now
</p>
<p><var>plaintext</var>: The data to be encrypted
</p>
<p><var>ciphertext</var>: contains the encrypted data
</p>
<p>This function will encrypt the given data, using the public
key. On success the <code>ciphertext</code> will be allocated using <code>gnutls_malloc()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport-1"></a>
<h4 class="subheading">gnutls_pubkey_export</h4>
<a name="gnutls_005fpubkey_005fexport"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport"></a>Function: <em>int</em> <strong>gnutls_pubkey_export</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_x509_crt_fmt_t <var>format</var>, void * <var>output_data</var>, size_t * <var>output_data_size</var>)</em></dt>
<dd><p><var>key</var>: Holds the certificate
</p>
<p><var>format</var>: the format of output params. One of PEM or DER.
</p>
<p><var>output_data</var>: will contain a certificate PEM or DER encoded
</p>
<p><var>output_data_size</var>: holds the size of output_data (and will be
replaced by the actual size of parameters)
</p>
<p>This function will export the public key to DER or PEM format.
The contents of the exported data is the SubjectPublicKeyInfo
X.509 structure.
</p>
<p>If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and <code>GNUTLS_E_SHORT_MEMORY_BUFFER</code> will
be returned.
</p>
<p>If the structure is PEM encoded, it will have a header
of "BEGIN CERTIFICATE".
</p>
<p><strong>Returns:</strong> In case of failure a negative error code will be
returned, and 0 on success.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport2-1"></a>
<h4 class="subheading">gnutls_pubkey_export2</h4>
<a name="gnutls_005fpubkey_005fexport2"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport2-1"></a>Function: <em>int</em> <strong>gnutls_pubkey_export2</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_x509_crt_fmt_t <var>format</var>, gnutls_datum_t * <var>out</var>)</em></dt>
<dd><p><var>key</var>: Holds the certificate
</p>
<p><var>format</var>: the format of output params. One of PEM or DER.
</p>
<p><var>out</var>: will contain a certificate PEM or DER encoded
</p>
<p>This function will export the public key to DER or PEM format.
The contents of the exported data is the SubjectPublicKeyInfo
X.509 structure.
</p>
<p>The output buffer will be allocated using <code>gnutls_malloc()</code> .
</p>
<p>If the structure is PEM encoded, it will have a header
of "BEGIN CERTIFICATE".
</p>
<p><strong>Returns:</strong> In case of failure a negative error code will be
returned, and 0 on success.
</p>
<p><strong>Since:</strong> 3.1.3
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport_005fdsa_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_export_dsa_raw</h4>
<a name="gnutls_005fpubkey_005fexport_005fdsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport_005fdsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_export_dsa_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_datum_t * <var>p</var>, gnutls_datum_t * <var>q</var>, gnutls_datum_t * <var>g</var>, gnutls_datum_t * <var>y</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>p</var>: will hold the p (may be <code>NULL</code> )
</p>
<p><var>q</var>: will hold the q (may be <code>NULL</code> )
</p>
<p><var>g</var>: will hold the g (may be <code>NULL</code> )
</p>
<p><var>y</var>: will hold the y (may be <code>NULL</code> )
</p>
<p>This function will export the DSA public key’s parameters found in
the given certificate. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p>This function allows for <code>NULL</code> parameters since 3.4.1.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport_005fecc_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_export_ecc_raw</h4>
<a name="gnutls_005fpubkey_005fexport_005fecc_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport_005fecc_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_export_ecc_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_ecc_curve_t * <var>curve</var>, gnutls_datum_t * <var>x</var>, gnutls_datum_t * <var>y</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>curve</var>: will hold the curve (may be <code>NULL</code> )
</p>
<p><var>x</var>: will hold x (may be <code>NULL</code> )
</p>
<p><var>y</var>: will hold y (may be <code>NULL</code> )
</p>
<p>This function will export the ECC public key’s parameters found in
the given key. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p>This function allows for <code>NULL</code> parameters since 3.4.1.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport_005fecc_005fx962-1"></a>
<h4 class="subheading">gnutls_pubkey_export_ecc_x962</h4>
<a name="gnutls_005fpubkey_005fexport_005fecc_005fx962"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport_005fecc_005fx962"></a>Function: <em>int</em> <strong>gnutls_pubkey_export_ecc_x962</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_datum_t * <var>parameters</var>, gnutls_datum_t * <var>ecpoint</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>parameters</var>: DER encoding of an ANSI X9.62 parameters
</p>
<p><var>ecpoint</var>: DER encoding of ANSI X9.62 ECPoint
</p>
<p>This function will export the ECC public key’s parameters found in
the given certificate. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fexport_005frsa_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_export_rsa_raw</h4>
<a name="gnutls_005fpubkey_005fexport_005frsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fexport_005frsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_export_rsa_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_datum_t * <var>m</var>, gnutls_datum_t * <var>e</var>)</em></dt>
<dd><p><var>key</var>: Holds the certificate
</p>
<p><var>m</var>: will hold the modulus (may be <code>NULL</code> )
</p>
<p><var>e</var>: will hold the public exponent (may be <code>NULL</code> )
</p>
<p>This function will export the RSA public key’s parameters found in
the given structure. The new parameters will be allocated using
<code>gnutls_malloc()</code> and will be stored in the appropriate datum.
</p>
<p>This function allows for <code>NULL</code> parameters since 3.4.1.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fget_005fkey_005fid-1"></a>
<h4 class="subheading">gnutls_pubkey_get_key_id</h4>
<a name="gnutls_005fpubkey_005fget_005fkey_005fid"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fget_005fkey_005fid"></a>Function: <em>int</em> <strong>gnutls_pubkey_get_key_id</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int <var>flags</var>, unsigned char * <var>output_data</var>, size_t * <var>output_data_size</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>flags</var>: should be one of the flags from <code>gnutls_keyid_flags_t</code>
</p>
<p><var>output_data</var>: will contain the key ID
</p>
<p><var>output_data_size</var>: holds the size of output_data (and will be
replaced by the actual size of parameters)
</p>
<p>This function will return a unique ID that depends on the public
key parameters. This ID can be used in checking whether a
certificate corresponds to the given public key.
</p>
<p>If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and <code>GNUTLS_E_SHORT_MEMORY_BUFFER</code> will
be returned. The output will normally be a SHA-1 hash output,
which is 20 bytes.
</p>
<p><strong>Returns:</strong> In case of failure a negative error code will be
returned, and 0 on success.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fget_005fkey_005fusage-1"></a>
<h4 class="subheading">gnutls_pubkey_get_key_usage</h4>
<a name="gnutls_005fpubkey_005fget_005fkey_005fusage"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fget_005fkey_005fusage"></a>Function: <em>int</em> <strong>gnutls_pubkey_get_key_usage</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int * <var>usage</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_pubkey_t</code> type
</p>
<p><var>usage</var>: If set will return the number of bits of the parameters (may be NULL)
</p>
<p>This function will return the key usage of the public key.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fget_005fopenpgp_005fkey_005fid-1"></a>
<h4 class="subheading">gnutls_pubkey_get_openpgp_key_id</h4>
<a name="gnutls_005fpubkey_005fget_005fopenpgp_005fkey_005fid"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fget_005fopenpgp_005fkey_005fid"></a>Function: <em>int</em> <strong>gnutls_pubkey_get_openpgp_key_id</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int <var>flags</var>, unsigned char * <var>output_data</var>, size_t * <var>output_data_size</var>, unsigned int * <var>subkey</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>flags</var>: should be 0 or <code>GNUTLS_PUBKEY_GET_OPENPGP_FINGERPRINT</code>
</p>
<p><var>output_data</var>: will contain the key ID
</p>
<p><var>output_data_size</var>: holds the size of output_data (and will be
replaced by the actual size of parameters)
</p>
<p><var>subkey</var>: Will be non zero if the key ID corresponds to a subkey
</p>
<p>This function returns the OpenPGP key ID of the corresponding key.
The key is a unique ID that depends on the public
key parameters.
</p>
<p>If the flag <code>GNUTLS_PUBKEY_GET_OPENPGP_FINGERPRINT</code> is specified
this function returns the fingerprint of the master key.
</p>
<p>If the buffer provided is not long enough to hold the output, then
*output_data_size is updated and <code>GNUTLS_E_SHORT_MEMORY_BUFFER</code> will
be returned. The output is <code>GNUTLS_OPENPGP_KEYID_SIZE</code> bytes long.
</p>
<p><strong>Returns:</strong> In case of failure a negative error code will be
returned, and 0 on success.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fget_005fpk_005falgorithm-1"></a>
<h4 class="subheading">gnutls_pubkey_get_pk_algorithm</h4>
<a name="gnutls_005fpubkey_005fget_005fpk_005falgorithm"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fget_005fpk_005falgorithm"></a>Function: <em>int</em> <strong>gnutls_pubkey_get_pk_algorithm</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int * <var>bits</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_pubkey_t</code> type
</p>
<p><var>bits</var>: If set will return the number of bits of the parameters (may be NULL)
</p>
<p>This function will return the public key algorithm of a public
key and if possible will return a number of bits that indicates
the security parameter of the key.
</p>
<p><strong>Returns:</strong> a member of the <code>gnutls_pk_algorithm_t</code> enumeration on
success, or a negative error code on error.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fget_005fpreferred_005fhash_005falgorithm-1"></a>
<h4 class="subheading">gnutls_pubkey_get_preferred_hash_algorithm</h4>
<a name="gnutls_005fpubkey_005fget_005fpreferred_005fhash_005falgorithm"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fget_005fpreferred_005fhash_005falgorithm"></a>Function: <em>int</em> <strong>gnutls_pubkey_get_preferred_hash_algorithm</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_digest_algorithm_t * <var>hash</var>, unsigned int * <var>mand</var>)</em></dt>
<dd><p><var>key</var>: Holds the certificate
</p>
<p><var>hash</var>: The result of the call with the hash algorithm used for signature
</p>
<p><var>mand</var>: If non zero it means that the algorithm MUST use this hash. May be NULL.
</p>
<p>This function will read the certificate and return the appropriate digest
algorithm to use for signing with this certificate. Some certificates (i.e.
DSA might not be able to sign without the preferred algorithm).
</p>
<p>To get the signature algorithm instead of just the hash use <code>gnutls_pk_to_sign()</code>
with the algorithm of the certificate/key and the provided <code>hash</code> .
</p>
<p><strong>Returns:</strong> the 0 if the hash algorithm is found. A negative error code is
returned on error.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport-1"></a>
<h4 class="subheading">gnutls_pubkey_import</h4>
<a name="gnutls_005fpubkey_005fimport"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport"></a>Function: <em>int</em> <strong>gnutls_pubkey_import</strong> <em>(gnutls_pubkey_t <var>key</var>, const gnutls_datum_t * <var>data</var>, gnutls_x509_crt_fmt_t <var>format</var>)</em></dt>
<dd><p><var>key</var>: The public key.
</p>
<p><var>data</var>: The DER or PEM encoded certificate.
</p>
<p><var>format</var>: One of DER or PEM
</p>
<p>This function will import the provided public key in
a SubjectPublicKeyInfo X.509 structure to a native
<code>gnutls_pubkey_t</code> type. The output will be stored
in <code>key</code> . If the public key is PEM encoded it should have a header
of "PUBLIC KEY".
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fdsa_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_dsa_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005fdsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fdsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_dsa_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, const gnutls_datum_t * <var>p</var>, const gnutls_datum_t * <var>q</var>, const gnutls_datum_t * <var>g</var>, const gnutls_datum_t * <var>y</var>)</em></dt>
<dd><p><var>key</var>: The structure to store the parsed key
</p>
<p><var>p</var>: holds the p
</p>
<p><var>q</var>: holds the q
</p>
<p><var>g</var>: holds the g
</p>
<p><var>y</var>: holds the y
</p>
<p>This function will convert the given DSA raw parameters to the
native <code>gnutls_pubkey_t</code> format. The output will be stored
in <code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fecc_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_ecc_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005fecc_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fecc_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_ecc_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_ecc_curve_t <var>curve</var>, const gnutls_datum_t * <var>x</var>, const gnutls_datum_t * <var>y</var>)</em></dt>
<dd><p><var>key</var>: The structure to store the parsed key
</p>
<p><var>curve</var>: holds the curve
</p>
<p><var>x</var>: holds the x
</p>
<p><var>y</var>: holds the y
</p>
<p>This function will convert the given elliptic curve parameters to a
<code>gnutls_pubkey_t</code> . The output will be stored in <code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fecc_005fx962-1"></a>
<h4 class="subheading">gnutls_pubkey_import_ecc_x962</h4>
<a name="gnutls_005fpubkey_005fimport_005fecc_005fx962"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fecc_005fx962"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_ecc_x962</strong> <em>(gnutls_pubkey_t <var>key</var>, const gnutls_datum_t * <var>parameters</var>, const gnutls_datum_t * <var>ecpoint</var>)</em></dt>
<dd><p><var>key</var>: The structure to store the parsed key
</p>
<p><var>parameters</var>: DER encoding of an ANSI X9.62 parameters
</p>
<p><var>ecpoint</var>: DER encoding of ANSI X9.62 ECPoint
</p>
<p>This function will convert the given elliptic curve parameters to a
<code>gnutls_pubkey_t</code> . The output will be stored in <code>key</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fopenpgp-1"></a>
<h4 class="subheading">gnutls_pubkey_import_openpgp</h4>
<a name="gnutls_005fpubkey_005fimport_005fopenpgp"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fopenpgp"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_openpgp</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_openpgp_crt_t <var>crt</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: The public key
</p>
<p><var>crt</var>: The certificate to be imported
</p>
<p><var>flags</var>: should be zero
</p>
<p>Imports a public key from an openpgp key. This function will import
the given public key to the abstract <code>gnutls_pubkey_t</code>
type. The subkey set as preferred will be imported or the
master key otherwise.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fopenpgp_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_openpgp_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005fopenpgp_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fopenpgp_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_openpgp_raw</strong> <em>(gnutls_pubkey_t <var>pkey</var>, const gnutls_datum_t * <var>data</var>, gnutls_openpgp_crt_fmt_t <var>format</var>, const gnutls_openpgp_keyid_t <var>keyid</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The public key
</p>
<p><var>data</var>: The public key data to be imported
</p>
<p><var>format</var>: The format of the public key
</p>
<p><var>keyid</var>: The key id to use (optional)
</p>
<p><var>flags</var>: Should be zero
</p>
<p>This function will import the given public key to the abstract
<code>gnutls_pubkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.3
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fpkcs11-1"></a>
<h4 class="subheading">gnutls_pubkey_import_pkcs11</h4>
<a name="gnutls_005fpubkey_005fimport_005fpkcs11"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fpkcs11"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_pkcs11</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_pkcs11_obj_t <var>obj</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: The public key
</p>
<p><var>obj</var>: The parameters to be imported
</p>
<p><var>flags</var>: should be zero
</p>
<p>Imports a public key from a pkcs11 key. This function will import
the given public key to the abstract <code>gnutls_pubkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fprivkey-1"></a>
<h4 class="subheading">gnutls_pubkey_import_privkey</h4>
<a name="gnutls_005fpubkey_005fimport_005fprivkey"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fprivkey"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_privkey</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_privkey_t <var>pkey</var>, unsigned int <var>usage</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: The public key
</p>
<p><var>pkey</var>: The private key
</p>
<p><var>usage</var>: GNUTLS_KEY_* key usage flags.
</p>
<p><var>flags</var>: should be zero
</p>
<p>Imports the public key from a private. This function will import
the given public key to the abstract <code>gnutls_pubkey_t</code> type.
</p>
<p>Note that in certain keys this operation may not be possible, e.g.,
in other than RSA PKCS<code>11</code> keys.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005frsa_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_rsa_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005frsa_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005frsa_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_rsa_raw</strong> <em>(gnutls_pubkey_t <var>key</var>, const gnutls_datum_t * <var>m</var>, const gnutls_datum_t * <var>e</var>)</em></dt>
<dd><p><var>key</var>: The key
</p>
<p><var>m</var>: holds the modulus
</p>
<p><var>e</var>: holds the public exponent
</p>
<p>This function will replace the parameters in the given structure.
The new parameters should be stored in the appropriate
gnutls_datum.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, or an negative error code.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005ftpm_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_tpm_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005ftpm_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005ftpm_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_tpm_raw</strong> <em>(gnutls_pubkey_t <var>pkey</var>, const gnutls_datum_t * <var>fdata</var>, gnutls_tpmkey_fmt_t <var>format</var>, const char * <var>srk_password</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The public key
</p>
<p><var>fdata</var>: The TPM key to be imported
</p>
<p><var>format</var>: The format of the private key
</p>
<p><var>srk_password</var>: The password for the SRK key (optional)
</p>
<p><var>flags</var>: One of the GNUTLS_PUBKEY_* flags
</p>
<p>This function will import the public key from the provided TPM key
structure.
</p>
<p>With respect to passwords the same as in
<code>gnutls_pubkey_import_tpm_url()</code> apply.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005ftpm_005furl-1"></a>
<h4 class="subheading">gnutls_pubkey_import_tpm_url</h4>
<a name="gnutls_005fpubkey_005fimport_005ftpm_005furl"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005ftpm_005furl-1"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_tpm_url</strong> <em>(gnutls_pubkey_t <var>pkey</var>, const char * <var>url</var>, const char * <var>srk_password</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The public key
</p>
<p><var>url</var>: The URL of the TPM key to be imported
</p>
<p><var>srk_password</var>: The password for the SRK key (optional)
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import the given private key to the abstract
<code>gnutls_privkey_t</code> type.
</p>
<p>Note that unless <code>GNUTLS_PUBKEY_DISABLE_CALLBACKS</code>
is specified, if incorrect (or NULL) passwords are given
the PKCS11 callback functions will be used to obtain the
correct passwords. Otherwise if the SRK password is wrong
<code>GNUTLS_E_TPM_SRK_PASSWORD_ERROR</code> is returned.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005furl-1"></a>
<h4 class="subheading">gnutls_pubkey_import_url</h4>
<a name="gnutls_005fpubkey_005fimport_005furl"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005furl"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_url</strong> <em>(gnutls_pubkey_t <var>key</var>, const char * <var>url</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_pubkey_t</code>
</p>
<p><var>url</var>: A PKCS 11 url
</p>
<p><var>flags</var>: One of GNUTLS_PKCS11_OBJ_* flags
</p>
<p>This function will import a public key from the provided URL.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fx509-1"></a>
<h4 class="subheading">gnutls_pubkey_import_x509</h4>
<a name="gnutls_005fpubkey_005fimport_005fx509"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fx509"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_x509</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_x509_crt_t <var>crt</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: The public key
</p>
<p><var>crt</var>: The certificate to be imported
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import the given public key to the abstract
<code>gnutls_pubkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fx509_005fcrq-1"></a>
<h4 class="subheading">gnutls_pubkey_import_x509_crq</h4>
<a name="gnutls_005fpubkey_005fimport_005fx509_005fcrq"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fx509_005fcrq"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_x509_crq</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_x509_crq_t <var>crq</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>key</var>: The public key
</p>
<p><var>crq</var>: The certificate to be imported
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import the given public key to the abstract
<code>gnutls_pubkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.5
</p></dd></dl>
<a name="gnutls_005fpubkey_005fimport_005fx509_005fraw-1"></a>
<h4 class="subheading">gnutls_pubkey_import_x509_raw</h4>
<a name="gnutls_005fpubkey_005fimport_005fx509_005fraw"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fimport_005fx509_005fraw"></a>Function: <em>int</em> <strong>gnutls_pubkey_import_x509_raw</strong> <em>(gnutls_pubkey_t <var>pkey</var>, const gnutls_datum_t * <var>data</var>, gnutls_x509_crt_fmt_t <var>format</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>pkey</var>: The public key
</p>
<p><var>data</var>: The public key data to be imported
</p>
<p><var>format</var>: The format of the public key
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will import the given public key to the abstract
<code>gnutls_pubkey_t</code> type.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.3
</p></dd></dl>
<a name="gnutls_005fpubkey_005finit-1"></a>
<h4 class="subheading">gnutls_pubkey_init</h4>
<a name="gnutls_005fpubkey_005finit"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005finit"></a>Function: <em>int</em> <strong>gnutls_pubkey_init</strong> <em>(gnutls_pubkey_t * <var>key</var>)</em></dt>
<dd><p><var>key</var>: A pointer to the type to be initialized
</p>
<p>This function will initialize a public key.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fprint-1"></a>
<h4 class="subheading">gnutls_pubkey_print</h4>
<a name="gnutls_005fpubkey_005fprint"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fprint"></a>Function: <em>int</em> <strong>gnutls_pubkey_print</strong> <em>(gnutls_pubkey_t <var>pubkey</var>, gnutls_certificate_print_formats_t <var>format</var>, gnutls_datum_t * <var>out</var>)</em></dt>
<dd><p><var>pubkey</var>: The data to be printed
</p>
<p><var>format</var>: Indicate the format to use
</p>
<p><var>out</var>: Newly allocated datum with null terminated string.
</p>
<p>This function will pretty print public key information, suitable for
display to a human.
</p>
<p>Only <code>GNUTLS_CRT_PRINT_FULL</code> and <code>GNUTLS_CRT_PRINT_FULL_NUMBERS</code>
are implemented.
</p>
<p>The output <code>out</code> needs to be deallocated using <code>gnutls_free()</code> .
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.1.5
</p></dd></dl>
<a name="gnutls_005fpubkey_005fset_005fkey_005fusage-1"></a>
<h4 class="subheading">gnutls_pubkey_set_key_usage</h4>
<a name="gnutls_005fpubkey_005fset_005fkey_005fusage"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fset_005fkey_005fusage"></a>Function: <em>int</em> <strong>gnutls_pubkey_set_key_usage</strong> <em>(gnutls_pubkey_t <var>key</var>, unsigned int <var>usage</var>)</em></dt>
<dd><p><var>key</var>: a certificate of type <code>gnutls_x509_crt_t</code>
</p>
<p><var>usage</var>: an ORed sequence of the GNUTLS_KEY_* elements.
</p>
<p>This function will set the key usage flags of the public key. This
is only useful if the key is to be exported to a certificate or
certificate request.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fset_005fpin_005ffunction-1"></a>
<h4 class="subheading">gnutls_pubkey_set_pin_function</h4>
<a name="gnutls_005fpubkey_005fset_005fpin_005ffunction"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fset_005fpin_005ffunction"></a>Function: <em>void</em> <strong>gnutls_pubkey_set_pin_function</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_pin_callback_t <var>fn</var>, void * <var>userdata</var>)</em></dt>
<dd><p><var>key</var>: A key of type <code>gnutls_pubkey_t</code>
</p>
<p><var>fn</var>: the callback
</p>
<p><var>userdata</var>: data associated with the callback
</p>
<p>This function will set a callback function to be used when
required to access the object. This function overrides any other
global PIN functions.
</p>
<p>Note that this function must be called right after initialization
to have effect.
</p>
<p><strong>Since:</strong> 3.1.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fverify_005fdata2-1"></a>
<h4 class="subheading">gnutls_pubkey_verify_data2</h4>
<a name="gnutls_005fpubkey_005fverify_005fdata2"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fverify_005fdata2-1"></a>Function: <em>int</em> <strong>gnutls_pubkey_verify_data2</strong> <em>(gnutls_pubkey_t <var>pubkey</var>, gnutls_sign_algorithm_t <var>algo</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>data</var>, const gnutls_datum_t * <var>signature</var>)</em></dt>
<dd><p><var>pubkey</var>: Holds the public key
</p>
<p><var>algo</var>: The signature algorithm used
</p>
<p><var>flags</var>: Zero or an OR list of <code>gnutls_certificate_verify_flags</code>
</p>
<p><var>data</var>: holds the signed data
</p>
<p><var>signature</var>: contains the signature
</p>
<p>This function will verify the given signed data, using the
parameters from the certificate.
</p>
<p><strong>Returns:</strong> In case of a verification failure <code>GNUTLS_E_PK_SIG_VERIFY_FAILED</code>
is returned, and zero or positive code on success. For known to be insecure
signatures this function will return <code>GNUTLS_E_INSUFFICIENT_SECURITY</code> unless
the flag <code>GNUTLS_VERIFY_ALLOW_BROKEN</code> is specified.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fverify_005fhash2-1"></a>
<h4 class="subheading">gnutls_pubkey_verify_hash2</h4>
<a name="gnutls_005fpubkey_005fverify_005fhash2"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fverify_005fhash2-1"></a>Function: <em>int</em> <strong>gnutls_pubkey_verify_hash2</strong> <em>(gnutls_pubkey_t <var>key</var>, gnutls_sign_algorithm_t <var>algo</var>, unsigned int <var>flags</var>, const gnutls_datum_t * <var>hash</var>, const gnutls_datum_t * <var>signature</var>)</em></dt>
<dd><p><var>key</var>: Holds the public key
</p>
<p><var>algo</var>: The signature algorithm used
</p>
<p><var>flags</var>: Zero or an OR list of <code>gnutls_certificate_verify_flags</code>
</p>
<p><var>hash</var>: holds the hash digest to be verified
</p>
<p><var>signature</var>: contains the signature
</p>
<p>This function will verify the given signed digest, using the
parameters from the public key. Note that unlike <code>gnutls_privkey_sign_hash()</code> ,
this function accepts a signature algorithm instead of a digest algorithm.
You can use <code>gnutls_pk_to_sign()</code> to get the appropriate value.
</p>
<p><strong>Returns:</strong> In case of a verification failure <code>GNUTLS_E_PK_SIG_VERIFY_FAILED</code>
is returned, and zero or positive code on success.
</p>
<p><strong>Since:</strong> 3.0
</p></dd></dl>
<a name="gnutls_005fpubkey_005fverify_005fparams-1"></a>
<h4 class="subheading">gnutls_pubkey_verify_params</h4>
<a name="gnutls_005fpubkey_005fverify_005fparams"></a><dl>
<dt><a name="index-gnutls_005fpubkey_005fverify_005fparams"></a>Function: <em>int</em> <strong>gnutls_pubkey_verify_params</strong> <em>(gnutls_pubkey_t <var>key</var>)</em></dt>
<dd><p><var>key</var>: should contain a <code>gnutls_pubkey_t</code> type
</p>
<p>This function will verify the private key parameters.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.3.0
</p></dd></dl>
<a name="gnutls_005fregister_005fcustom_005furl-1"></a>
<h4 class="subheading">gnutls_register_custom_url</h4>
<a name="gnutls_005fregister_005fcustom_005furl"></a><dl>
<dt><a name="index-gnutls_005fregister_005fcustom_005furl-1"></a>Function: <em>int</em> <strong>gnutls_register_custom_url</strong> <em>(const gnutls_custom_url_st * <var>st</var>)</em></dt>
<dd><p><var>st</var>: A <code>gnutls_custom_url_st</code> structure
</p>
<p>Register a custom URL. This will affect the following functions:
<code>gnutls_url_is_supported()</code> , <code>gnutls_privkey_import_url()</code> ,
gnutls_pubkey_import_url, <code>gnutls_x509_crt_import_url()</code>
and all functions that depend on
them, e.g., <code>gnutls_certificate_set_x509_key_file2()</code> .
</p>
<p>The provided structure and callback functions must be valid throughout
the lifetime of the process. The registration of an existing URL type
will fail with <code>GNUTLS_E_INVALID_REQUEST</code> . Since GnuTLS 3.5.0 this function
can be used to override the builtin URLs.
</p>
<p>This function is not thread safe.
</p>
<p><strong>Returns:</strong> returns zero if the given structure was imported or a negative value otherwise.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fsystem_005fkey_005fadd_005fx509-1"></a>
<h4 class="subheading">gnutls_system_key_add_x509</h4>
<a name="gnutls_005fsystem_005fkey_005fadd_005fx509"></a><dl>
<dt><a name="index-gnutls_005fsystem_005fkey_005fadd_005fx509"></a>Function: <em>int</em> <strong>gnutls_system_key_add_x509</strong> <em>(gnutls_x509_crt_t <var>crt</var>, gnutls_x509_privkey_t <var>privkey</var>, const char * <var>label</var>, char ** <var>cert_url</var>, char ** <var>key_url</var>)</em></dt>
<dd><p><var>crt</var>: the certificate to be added
</p>
<p><var>privkey</var>: the key to be added
</p>
<p><var>label</var>: the friendly name to describe the key
</p>
<p><var>cert_url</var>: if non-NULL it will contain an allocated value with the certificate URL
</p>
<p><var>key_url</var>: if non-NULL it will contain an allocated value with the key URL
</p>
<p>This function will added the given key and certificate pair,
to the system list.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fsystem_005fkey_005fdelete-1"></a>
<h4 class="subheading">gnutls_system_key_delete</h4>
<a name="gnutls_005fsystem_005fkey_005fdelete"></a><dl>
<dt><a name="index-gnutls_005fsystem_005fkey_005fdelete"></a>Function: <em>int</em> <strong>gnutls_system_key_delete</strong> <em>(const char * <var>cert_url</var>, const char * <var>key_url</var>)</em></dt>
<dd><p><var>cert_url</var>: the URL of the certificate
</p>
<p><var>key_url</var>: the URL of the key
</p>
<p>This function will delete the key and certificate pair.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fsystem_005fkey_005fiter_005fdeinit-1"></a>
<h4 class="subheading">gnutls_system_key_iter_deinit</h4>
<a name="gnutls_005fsystem_005fkey_005fiter_005fdeinit"></a><dl>
<dt><a name="index-gnutls_005fsystem_005fkey_005fiter_005fdeinit"></a>Function: <em>void</em> <strong>gnutls_system_key_iter_deinit</strong> <em>(gnutls_system_key_iter_t <var>iter</var>)</em></dt>
<dd><p><var>iter</var>: an iterator of system keys
</p>
<p>This function will deinitialize the iterator.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fsystem_005fkey_005fiter_005fget_005finfo-1"></a>
<h4 class="subheading">gnutls_system_key_iter_get_info</h4>
<a name="gnutls_005fsystem_005fkey_005fiter_005fget_005finfo"></a><dl>
<dt><a name="index-gnutls_005fsystem_005fkey_005fiter_005fget_005finfo-1"></a>Function: <em>int</em> <strong>gnutls_system_key_iter_get_info</strong> <em>(gnutls_system_key_iter_t * <var>iter</var>, unsigned <var>cert_type</var>, char ** <var>cert_url</var>, char ** <var>key_url</var>, char ** <var>label</var>, gnutls_datum_t * <var>der</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>iter</var>: an iterator of the system keys (must be set to <code>NULL</code> initially)
</p>
<p><var>cert_type</var>: A value of gnutls_certificate_type_t which indicates the type of certificate to look for
</p>
<p><var>cert_url</var>: The certificate URL of the pair (may be <code>NULL</code> )
</p>
<p><var>key_url</var>: The key URL of the pair (may be <code>NULL</code> )
</p>
<p><var>label</var>: The friendly name (if any) of the pair (may be <code>NULL</code> )
</p>
<p><var>der</var>: if non-NULL the DER data of the certificate
</p>
<p><var>flags</var>: should be zero
</p>
<p>This function will return on each call a certificate
and key pair URLs, as well as a label associated with them,
and the DER-encoded certificate. When the iteration is complete it will
return <code>GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE</code> .
</p>
<p>Typically <code>cert_type</code> should be <code>GNUTLS_CRT_X509</code> .
</p>
<p>All values set are allocated and must be cleared using <code>gnutls_free()</code> ,
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 3.4.0
</p></dd></dl>
<a name="gnutls_005fx509_005fcrl_005fprivkey_005fsign-1"></a>
<h4 class="subheading">gnutls_x509_crl_privkey_sign</h4>
<a name="gnutls_005fx509_005fcrl_005fprivkey_005fsign"></a><dl>
<dt><a name="index-gnutls_005fx509_005fcrl_005fprivkey_005fsign-1"></a>Function: <em>int</em> <strong>gnutls_x509_crl_privkey_sign</strong> <em>(gnutls_x509_crl_t <var>crl</var>, gnutls_x509_crt_t <var>issuer</var>, gnutls_privkey_t <var>issuer_key</var>, gnutls_digest_algorithm_t <var>dig</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>crl</var>: should contain a gnutls_x509_crl_t type
</p>
<p><var>issuer</var>: is the certificate of the certificate issuer
</p>
<p><var>issuer_key</var>: holds the issuer’s private key
</p>
<p><var>dig</var>: The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you’re doing.
</p>
<p><var>flags</var>: must be 0
</p>
<p>This function will sign the CRL with the issuer’s private key, and
will copy the issuer’s information into the CRL.
</p>
<p>This must be the last step in a certificate CRL since all
the previously set parameters are now signed.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p>Since 2.12.0
</p></dd></dl>
<a name="gnutls_005fx509_005fcrq_005fprivkey_005fsign-1"></a>
<h4 class="subheading">gnutls_x509_crq_privkey_sign</h4>
<a name="gnutls_005fx509_005fcrq_005fprivkey_005fsign"></a><dl>
<dt><a name="index-gnutls_005fx509_005fcrq_005fprivkey_005fsign"></a>Function: <em>int</em> <strong>gnutls_x509_crq_privkey_sign</strong> <em>(gnutls_x509_crq_t <var>crq</var>, gnutls_privkey_t <var>key</var>, gnutls_digest_algorithm_t <var>dig</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>crq</var>: should contain a <code>gnutls_x509_crq_t</code> type
</p>
<p><var>key</var>: holds a private key
</p>
<p><var>dig</var>: The message digest to use, i.e., <code>GNUTLS_DIG_SHA1</code>
</p>
<p><var>flags</var>: must be 0
</p>
<p>This function will sign the certificate request with a private key.
This must be the same key as the one used in
<code>gnutls_x509_crt_set_key()</code> since a certificate request is self
signed.
</p>
<p>This must be the last step in a certificate request generation
since all the previously set parameters are now signed.
</p>
<p><strong>Returns:</strong> <code>GNUTLS_E_SUCCESS</code> on success, otherwise a negative error code.
<code>GNUTLS_E_ASN1_VALUE_NOT_FOUND</code> is returned if you didn’t set all
information in the certificate request (e.g., the version using
<code>gnutls_x509_crq_set_version()</code> ).
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fx509_005fcrq_005fset_005fpubkey-1"></a>
<h4 class="subheading">gnutls_x509_crq_set_pubkey</h4>
<a name="gnutls_005fx509_005fcrq_005fset_005fpubkey"></a><dl>
<dt><a name="index-gnutls_005fx509_005fcrq_005fset_005fpubkey-1"></a>Function: <em>int</em> <strong>gnutls_x509_crq_set_pubkey</strong> <em>(gnutls_x509_crq_t <var>crq</var>, gnutls_pubkey_t <var>key</var>)</em></dt>
<dd><p><var>crq</var>: should contain a <code>gnutls_x509_crq_t</code> type
</p>
<p><var>key</var>: holds a public key
</p>
<p>This function will set the public parameters from the given public
key to the request. The <code>key</code> can be deallocated after that.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<a name="gnutls_005fx509_005fcrt_005fprivkey_005fsign-1"></a>
<h4 class="subheading">gnutls_x509_crt_privkey_sign</h4>
<a name="gnutls_005fx509_005fcrt_005fprivkey_005fsign"></a><dl>
<dt><a name="index-gnutls_005fx509_005fcrt_005fprivkey_005fsign"></a>Function: <em>int</em> <strong>gnutls_x509_crt_privkey_sign</strong> <em>(gnutls_x509_crt_t <var>crt</var>, gnutls_x509_crt_t <var>issuer</var>, gnutls_privkey_t <var>issuer_key</var>, gnutls_digest_algorithm_t <var>dig</var>, unsigned int <var>flags</var>)</em></dt>
<dd><p><var>crt</var>: a certificate of type <code>gnutls_x509_crt_t</code>
</p>
<p><var>issuer</var>: is the certificate of the certificate issuer
</p>
<p><var>issuer_key</var>: holds the issuer’s private key
</p>
<p><var>dig</var>: The message digest to use, <code>GNUTLS_DIG_SHA1</code> is a safe choice
</p>
<p><var>flags</var>: must be 0
</p>
<p>This function will sign the certificate with the issuer’s private key, and
will copy the issuer’s information into the certificate.
</p>
<p>This must be the last step in a certificate generation since all
the previously set parameters are now signed.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p></dd></dl>
<a name="gnutls_005fx509_005fcrt_005fset_005fpubkey-1"></a>
<h4 class="subheading">gnutls_x509_crt_set_pubkey</h4>
<a name="gnutls_005fx509_005fcrt_005fset_005fpubkey"></a><dl>
<dt><a name="index-gnutls_005fx509_005fcrt_005fset_005fpubkey-1"></a>Function: <em>int</em> <strong>gnutls_x509_crt_set_pubkey</strong> <em>(gnutls_x509_crt_t <var>crt</var>, gnutls_pubkey_t <var>key</var>)</em></dt>
<dd><p><var>crt</var>: should contain a <code>gnutls_x509_crt_t</code> type
</p>
<p><var>key</var>: holds a public key
</p>
<p>This function will set the public parameters from the given public
key to the certificate. The <code>key</code> can be deallocated after that.
</p>
<p><strong>Returns:</strong> On success, <code>GNUTLS_E_SUCCESS</code> (0) is returned, otherwise a
negative error value.
</p>
<p><strong>Since:</strong> 2.12.0
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Socket-specific-API.html#Socket-specific-API" accesskey="n" rel="next">Socket specific API</a>, Previous: <a href="TPM-API.html#TPM-API" accesskey="p" rel="prev">TPM API</a>, Up: <a href="API-reference.html#API-reference" accesskey="u" rel="up">API reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
