/usr/include/Qca-qt5/QtCrypto/qca_cert.h is in libqca-qt5-2-dev 2.1.1-4+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 | /*
* qca_cert.h - Qt Cryptographic Architecture
* Copyright (C) 2003-2007 Justin Karneges <justin@affinix.com>
* Copyright (C) 2004-2006 Brad Hards <bradh@frogmouth.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
/**
\file qca_cert.h
Header file for PGP key and X.509 certificate related classes
\note You should not use this header directly from an
application. You should just use <tt> \#include \<QtCrypto>
</tt> instead.
*/
#ifndef QCA_CERT_H
#define QCA_CERT_H
#include <QDateTime>
#include "qca_core.h"
#include "qca_publickey.h"
namespace QCA {
class CertContext;
class CSRContext;
class CRLContext;
class Certificate;
class CRL;
class CertificateCollection;
class CertificateChain;
/**
Certificate Request Format
*/
enum CertificateRequestFormat
{
PKCS10, ///< standard PKCS#10 format
SPKAC ///< Signed Public Key and Challenge (Netscape) format
};
/**
Known types of information stored in certificates
This enumerator offers a convenient way to work with common types.
*/
enum CertificateInfoTypeKnown
{
CommonName, ///< The common name (eg person), id = "2.5.4.3"
Email, ///< Email address, id = "GeneralName.rfc822Name"
EmailLegacy, ///< PKCS#9 Email field, id = "1.2.840.113549.1.9.1"
Organization, ///< An organisation (eg company), id = "2.5.4.10"
OrganizationalUnit, ///< An part of an organisation (eg a division or branch), id = "2.5.4.11"
Locality, ///< The locality (eg city, a shire, or part of a state), id = "2.5.4.7"
IncorporationLocality, ///< The locality of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.1"
State, ///< The state within the country, id = "2.5.4.8"
IncorporationState, ///< The state of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.2"
Country, ///< The country, id = "2.5.4.6"
IncorporationCountry, ///< The country of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.3"
URI, ///< Uniform Resource Identifier, id = "GeneralName.uniformResourceIdentifier"
DNS, ///< DNS name, id = "GeneralName.dNSName"
IPAddress, ///< IP address, id = "GeneralName.iPAddress"
XMPP ///< XMPP address (see http://www.ietf.org/rfc/rfc3920.txt), id = "1.3.6.1.5.5.7.8.5"
};
/**
\class CertificateInfoType qca_cert.h QtCrypto
Certificate information type
This class represents a type of information being stored in
a certificate. It can be created either using a known type
(from the Known enumerator) or an identifier string (usually
an OID). Types created either way are interchangeable.
Types also have the notion of a Section. Some types may
reside in the Distinguished Name field of a certificate, and
some types may reside in the Subject Alternative Name field.
This class is capable of representing a type from either
section.
In the general case, applications will want to use the
CertificateInfoTypeKnown enumerator types. These are from RFC3280
(http://www.ietf.org/rfc/rfc3280.txt) except where shown.
The entries for IncorporationLocality, IncorporationState
and IncorporationCountry are the same as Locality, State
and Country respectively, except that the Extended
Validation (EV) certificate guidelines (published by the
%Certificate Authority / Browser Forum, see
http://www.cabforum.org) distinguish between the place of
where the company does business (which is the Locality /
State / Country combination) and the jurisdiction where the
company is legally incorporated (the IncorporationLocality
/ IncorporationState / IncorporationCountry combination).
\sa Certificate::subjectInfo() and Certificate::issuerInfo()
\sa CRL::issuerInfo()
\ingroup UserAPI
*/
class QCA_EXPORT CertificateInfoType
{
public:
/**
Section of the certificate that the information belongs in
*/
enum Section
{
DN, ///< Distinguished name (the primary name)
AlternativeName ///< Alternative name
};
/**
Standard constructor
*/
CertificateInfoType();
/**
Construct a new type
The section will be derived by \a known.
\param known the type as part of the CertificateInfoTypeKnown
enumerator
*/
CertificateInfoType(CertificateInfoTypeKnown known);
/**
Construct a new type
\param id the type as an identifier string (OID or internal)
\param section the section this type belongs in
\sa id
*/
CertificateInfoType(const QString &id, Section section);
/**
Standard copy constructor
\param from the certificate information to copy from
*/
CertificateInfoType(const CertificateInfoType &from);
~CertificateInfoType();
/**
Standard assignment operator
\param from the certificate information to assign from
*/
CertificateInfoType & operator=(const CertificateInfoType &from);
/**
The section the type is part of
*/
Section section() const;
/**
The type as part of the CertificateInfoTypeKnown enumerator
This function may return a value that does not exist in the
enumerator. In that case, you may use id() to determine the
type.
*/
CertificateInfoTypeKnown known() const;
/**
The type as an identifier string
For types that have OIDs, this function returns an OID in string
form. For types that do not have OIDs, this function returns an
internal identifier string whose first character is not a digit
(this allows you to tell the difference between an OID and an
internal identifier).
It is hereby stated that General Names (of the X.509 Subject
Alternative Name) shall use the internal identifier format
"GeneralName.[rfc field name]". For example, the rfc822Name
field would have the identifier "GeneralName.rfc822Name".
Applications should not store, use, or compare against internal
identifiers unless the identifiers are explicitly documented
(e.g. GeneralName).
*/
QString id() const;
/**
Comparison operator
\param other the certificate information to compare with this
certificate information.
*/
bool operator<(const CertificateInfoType &other) const;
/**
Comparison operator
\param other the certificate information to compare with this
certificate information.
*/
bool operator==(const CertificateInfoType &other) const;
/**
Inequality operator
\param other the certificate information to compare with this
certificate information.
*/
inline bool operator!=(const CertificateInfoType &other) const
{
return !(*this == other);
}
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
\class CertificateInfoPair qca_cert.h QtCrypto
One entry in a certificate information list
\ingroup UserAPI
*/
class QCA_EXPORT CertificateInfoPair
{
public:
/**
Standard constructor
*/
CertificateInfoPair();
/**
Construct a new pair
\param type the type of information stored in this pair
\param value the value of the information to be stored
*/
CertificateInfoPair(const CertificateInfoType &type, const QString &value);
/**
Standard copy constructor
\param from the information pair to copy from
*/
CertificateInfoPair(const CertificateInfoPair &from);
~CertificateInfoPair();
/**
Standard assignment operator
\param from the information pair to assign from
*/
CertificateInfoPair & operator=(const CertificateInfoPair &from);
/**
The type of information stored in the pair
*/
CertificateInfoType type() const;
/**
The value of the information stored in the pair
*/
QString value() const;
/**
Comparison operator
\param other the certificate information pair to compare with this
certificate information pair.
*/
bool operator==(const CertificateInfoPair &other) const;
/**
Inequality operator
\param other the certificate information pair to compare with this
certificate information pair.
*/
inline bool operator!=(const CertificateInfoPair &other) const
{
return !(*this == other);
}
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
Known types of certificate constraints
This enumerator offers a convenient way to work with common types.
*/
enum ConstraintTypeKnown
{
// KeyUsage
DigitalSignature, ///< %Certificate can be used to create digital signatures, id = "KeyUsage.digitalSignature"
NonRepudiation, ///< %Certificate can be used for non-repudiation, id = "KeyUsage.nonRepudiation"
KeyEncipherment, ///< %Certificate can be used for encrypting / decrypting keys, id = "KeyUsage.keyEncipherment"
DataEncipherment, ///< %Certificate can be used for encrypting / decrypting data, id = "KeyUsage.dataEncipherment"
KeyAgreement, ///< %Certificate can be used for key agreement, id = "KeyUsage.keyAgreement"
KeyCertificateSign, ///< %Certificate can be used for key certificate signing, id = "KeyUsage.keyCertSign"
CRLSign, ///< %Certificate can be used to sign %Certificate Revocation Lists, id = "KeyUsage.crlSign"
EncipherOnly, ///< %Certificate can only be used for encryption, id = "KeyUsage.encipherOnly"
DecipherOnly, ///< %Certificate can only be used for decryption, id = "KeyUsage.decipherOnly"
// ExtKeyUsage
ServerAuth, ///< %Certificate can be used for server authentication (e.g. web server), id = "1.3.6.1.5.5.7.3.1". This is an extended usage constraint.
ClientAuth, ///< %Certificate can be used for client authentication (e.g. web browser), id = "1.3.6.1.5.5.7.3.2". This is an extended usage constraint.
CodeSigning, ///< %Certificate can be used to sign code, id = "1.3.6.1.5.5.7.3.3". This is an extended usage constraint.
EmailProtection, ///< %Certificate can be used to sign / encrypt email, id = "1.3.6.1.5.5.7.3.4". This is an extended usage constraint.
IPSecEndSystem, ///< %Certificate can be used to authenticate a endpoint in IPSEC, id = "1.3.6.1.5.5.7.3.5". This is an extended usage constraint.
IPSecTunnel, ///< %Certificate can be used to authenticate a tunnel in IPSEC, id = "1.3.6.1.5.5.7.3.6". This is an extended usage constraint.
IPSecUser, ///< %Certificate can be used to authenticate a user in IPSEC, id = "1.3.6.1.5.5.7.3.7". This is an extended usage constraint.
TimeStamping, ///< %Certificate can be used to create a "time stamp" signature, id = "1.3.6.1.5.5.7.3.8". This is an extended usage constraint.
OCSPSigning ///< %Certificate can be used to sign an Online %Certificate Status Protocol (OCSP) assertion, id = "1.3.6.1.5.5.7.3.9". This is an extended usage constraint.
};
/**
\class ConstraintType qca_cert.h QtCrypto
Certificate constraint
X.509 certificates can be constrained in their application - that is, some
certificates can only be used for certain purposes. This class is used to
identify an approved purpose for a certificate.
\note It is common for a certificate to have more than one purpose.
\ingroup UserAPI
*/
class QCA_EXPORT ConstraintType
{
public:
/**
Section of the certificate that the constraint belongs in
*/
enum Section
{
KeyUsage, ///< Stored in the key usage section
ExtendedKeyUsage ///< Stored in the extended key usage section
};
/**
Standard constructor
*/
ConstraintType();
/**
Construct a new constraint
The section will be derived by \a known.
\param known the type as part of the ConstraintTypeKnown
enumerator
*/
ConstraintType(ConstraintTypeKnown known);
/**
Construct a new constraint
\param id the type as an identifier string (OID or internal)
\param section the section this type belongs in
\sa id
*/
ConstraintType(const QString &id, Section section);
/**
Standard copy constructor
\param from the constraint type to copy from
*/
ConstraintType(const ConstraintType &from);
~ConstraintType();
/**
Standard assignment operator
\param from the constraint type to assign from
*/
ConstraintType & operator=(const ConstraintType &from);
/**
The section the constraint is part of
*/
Section section() const;
/**
The type as part of the ConstraintTypeKnown enumerator
This function may return a value that does not exist in the
enumerator. In that case, you may use id() to determine the
type.
*/
ConstraintTypeKnown known() const;
/**
The type as an identifier string
For types that have OIDs, this function returns an OID in string
form. For types that do not have OIDs, this function returns an
internal identifier string whose first character is not a digit
(this allows you to tell the difference between an OID and an
internal identifier).
It is hereby stated that the KeyUsage bit fields shall use the
internal identifier format "KeyUsage.[rfc field name]". For
example, the keyEncipherment field would have the identifier
"KeyUsage.keyEncipherment".
Applications should not store, use, or compare against internal
identifiers unless the identifiers are explicitly documented
(e.g. KeyUsage).
*/
QString id() const;
/**
Comparison operator
\param other the constraint type to compare with this constraint
*/
bool operator<(const ConstraintType &other) const;
/**
Comparison operator
\param other the constraint type to compare with this constraint
*/
bool operator==(const ConstraintType &other) const;
/**
Inequality operator
\param other the constraint type to compare with this constraint
*/
inline bool operator!=(const ConstraintType &other) const
{
return !(*this == other);
}
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
Specify the intended usage of a certificate
*/
enum UsageMode
{
UsageAny = 0x00, ///< Any application, or unspecified
UsageTLSServer = 0x01, ///< server side of a TLS or SSL connection
UsageTLSClient = 0x02, ///< client side of a TLS or SSL connection
UsageCodeSigning = 0x04, ///< code signing certificate
UsageEmailProtection = 0x08, ///< email (S/MIME) certificate
UsageTimeStamping = 0x10, ///< time stamping certificate
UsageCRLSigning = 0x20 ///< certificate revocation list signing certificate
};
/**
The validity (or otherwise) of a certificate
*/
enum Validity
{
ValidityGood, ///< The certificate is valid
ErrorRejected, ///< The root CA rejected the certificate purpose
ErrorUntrusted, ///< The certificate is not trusted
ErrorSignatureFailed, ///< The signature does not match
ErrorInvalidCA, ///< The Certificate Authority is invalid
ErrorInvalidPurpose, ///< The purpose does not match the intended usage
ErrorSelfSigned, ///< The certificate is self-signed, and is not found in the list of trusted certificates
ErrorRevoked, ///< The certificate has been revoked
ErrorPathLengthExceeded, ///< The path length from the root CA to this certificate is too long
ErrorExpired, ///< The certificate has expired, or is not yet valid (e.g. current time is earlier than notBefore time)
ErrorExpiredCA, ///< The Certificate Authority has expired
ErrorValidityUnknown = 64 ///< Validity is unknown
};
/**
The conditions to validate for a certificate
*/
enum ValidateFlags
{
ValidateAll = 0x00, // Verify all conditions
ValidateRevoked = 0x01, // Verify the certificate was not revoked
ValidateExpired = 0x02, // Verify the certificate has not expired
ValidatePolicy = 0x04 // Verify the certificate can be used for a specified purpose
};
/**
Certificate properties type
With this container, the information is not necessarily stored
in the same sequence as the certificate format itself. Use this
container if the order the information is/was stored does not
matter for you (this is the case with most applications).
Additionally, the EmailLegacy type should not be used with this
container. Use Email instead.
*/
typedef QMultiMap<CertificateInfoType, QString> CertificateInfo;
/**
\class CertificateInfoOrdered qca_cert.h QtCrypto
Ordered certificate properties type
This container stores the information in the same sequence as
the certificate format itself.
\ingroup UserAPI
*/
class CertificateInfoOrdered : public QList<CertificateInfoPair>
{
public:
/**
Convert to RFC 1779 string format
*/
inline QString toString() const;
/**
Return a new CertificateInfoOrdered that only contains
the Distinguished Name (DN) types found in this object.
*/
inline CertificateInfoOrdered dnOnly() const;
};
/**
Convert to RFC 1779 string format
\param in the certificate info to convert
*/
QCA_EXPORT QString orderedToDNString(const CertificateInfoOrdered &in);
/**
Return a new CertificateInfoOrdered that only contains
the Distinguished Name (DN) types found in the input object.
\param in the certificate info to extract from
*/
QCA_EXPORT CertificateInfoOrdered orderedDNOnly(const CertificateInfoOrdered &in);
inline QString CertificateInfoOrdered::toString() const
{
return orderedToDNString(*this);
}
inline CertificateInfoOrdered CertificateInfoOrdered::dnOnly() const
{
return orderedDNOnly(*this);
}
/**
%Certificate constraints type
*/
typedef QList<ConstraintType> Constraints;
/**
Create a list of unique friendly names among a list of certificates
\param list the list of certificates for which a friendly name is required.
*/
QCA_EXPORT QStringList makeFriendlyNames(const QList<Certificate> &list);
/**
\class CertificateOptions qca_cert.h QtCrypto
%Certificate options
\note In SPKAC mode, all options are ignored except for challenge
\ingroup UserAPI
*/
class QCA_EXPORT CertificateOptions
{
public:
/**
Create a Certificate options set
\param format the format to create the certificate request in
*/
CertificateOptions(CertificateRequestFormat format = PKCS10);
/**
Standard copy constructor
\param from the Certificate Options to copy into this object
*/
CertificateOptions(const CertificateOptions &from);
~CertificateOptions();
/**
Standard assignment operator
\param from the Certificate Options to copy into this object
*/
CertificateOptions & operator=(const CertificateOptions &from);
/**
test the format type for this certificate
*/
CertificateRequestFormat format() const;
/**
Specify the format for this certificate
\param f the format to use
*/
void setFormat(CertificateRequestFormat f);
/**
Test if the certificate options object is valid
\return true if the certificate options object is valid
*/
bool isValid() const;
/**
The challenge part of the certificate
For CertificateRequest only
\sa setChallenge
*/
QString challenge() const;
/**
Information on the subject of the certificate
\sa setInfo
*/
CertificateInfo info() const;
/**
Information on the subject of the certificate, in the
exact order the items will be written
\sa setInfoOrdered
*/
CertificateInfoOrdered infoOrdered() const;
/**
List the constraints on this certificate
*/
Constraints constraints() const;
/**
list the policies on this certificate
*/
QStringList policies() const;
/**
list of URI locations for CRL files
each URI refers to the same CRL file
For Certificate creation only
*/
QStringList crlLocations() const;
/**
list of URI locations for issuer certificate files
each URI refers to the same issuer file
For Certificate creation only
*/
QStringList issuerLocations() const;
/**
list of URI locations for OCSP services
For Certificate creation only
*/
QStringList ocspLocations() const;
/**
test if the certificate is a CA cert
\sa setAsCA
\sa setAsUser
*/
bool isCA() const;
/**
return the path limit on this certificate
*/
int pathLimit() const;
/**
The serial number for the certificate
For Certificate creation only
*/
BigInteger serialNumber() const;
/**
the first time the certificate will be valid
For Certificate creation only
*/
QDateTime notValidBefore() const;
/**
the last time the certificate is valid
For Certificate creation only
*/
QDateTime notValidAfter() const;
/**
Specify the challenge associated with this
certificate
\param s the challenge string
\sa challenge()
*/
void setChallenge(const QString &s);
/**
Specify information for the the subject associated with the
certificate
\param info the information for the subject
\sa info()
*/
void setInfo(const CertificateInfo &info);
/**
Specify information for the the subject associated with the
certificate
\param info the information for the subject
\sa info()
*/
void setInfoOrdered(const CertificateInfoOrdered &info);
/**
set the constraints on the certificate
\param constraints the constraints to be used for the certificate
*/
void setConstraints(const Constraints &constraints);
/**
set the policies on the certificate
\param policies the policies to be used for the certificate
*/
void setPolicies(const QStringList &policies);
/**
set the CRL locations of the certificate
each location refers to the same CRL.
\param locations a list of URIs to CRL files
*/
void setCRLLocations(const QStringList &locations);
/**
set the issuer certificate locations of the certificate
each location refers to the same issuer file.
\param locations a list of URIs to issuer certificate files
*/
void setIssuerLocations(const QStringList &locations);
/**
set the OCSP service locations of the certificate
\param locations a list of URIs to OCSP services
*/
void setOCSPLocations(const QStringList &locations);
/**
set the certificate to be a CA cert
\param pathLimit the number of intermediate certificates allowable
*/
void setAsCA(int pathLimit = 8); // value from Botan
/**
set the certificate to be a user cert (this is the default)
*/
void setAsUser();
/**
Set the serial number property on this certificate
\param i the serial number to use
*/
void setSerialNumber(const BigInteger &i);
/**
Set the validity period for the certificate
\param start the first time this certificate becomes valid
\param end the last time this certificate is valid
*/
void setValidityPeriod(const QDateTime &start, const QDateTime &end);
private:
class Private;
Private *d;
};
/**
\class Certificate qca_cert.h QtCrypto
Public Key (X.509) certificate
This class contains one X.509 certificate
\ingroup UserAPI
*/
class QCA_EXPORT Certificate : public Algorithm
{
public:
/**
Create an empty Certificate
*/
Certificate();
/**
Create a Certificate from a PEM encoded file
\param fileName the name (and path, if required)
of the file that contains the PEM encoded certificate
*/
Certificate(const QString &fileName);
/**
Create a Certificate with specified options and a specified private
key
\param opts the options to use
\param key the private key for this certificate
\param provider the provider to use to create this key, if a
particular provider is required
*/
Certificate(const CertificateOptions &opts, const PrivateKey &key, const QString &provider = QString());
/**
Standard copy constructor
\param from the certificate to copy from
*/
Certificate(const Certificate &from);
~Certificate();
/**
Standard assignment operator
\param from the Certificate to assign from
*/
Certificate & operator=(const Certificate &from);
/**
Test if the certificate is empty (null)
\return true if the certificate is null
*/
bool isNull() const;
/**
The earliest date that the certificate is valid
*/
QDateTime notValidBefore() const;
/**
The latest date that the certificate is valid
*/
QDateTime notValidAfter() const;
/**
Properties of the subject of the certificate, as a QMultiMap
This is the method that provides information on the
subject organisation, common name, DNS name, and so
on. The list of information types (i.e. the key to
the multi-map) is a CertificateInfoType. The values
are a list of QString.
An example of how you can iterate over the list is:
\code
foreach( QString dns, info.values(QCA::DNS) )
{
std::cout << " " << qPrintable(dns) << std::endl;
}
\endcode
*/
CertificateInfo subjectInfo() const;
/**
Properties of the subject of the certificate, as
an ordered list (QList of CertificateInfoPair).
This allows access to the certificate information
in the same order as they appear in a certificate.
Each pair in the list has a type and a value.
For example:
\code
CertificateInfoOrdered info = cert.subjectInfoOrdered();
// info[0].type == CommonName
// info[0].value == "example.com"
\endcode
\sa subjectInfo for an unordered version
\sa issuerInfoOrdered for the ordered information on the issuer
\sa CertificateInfoPair for the elements in the list
*/
CertificateInfoOrdered subjectInfoOrdered() const;
/**
Properties of the issuer of the certificate
\sa subjectInfo for how the return value works.
*/
CertificateInfo issuerInfo() const;
/**
Properties of the issuer of the certificate, as
an ordered list (QList of CertificateInfoPair).
This allows access to the certificate information
in the same order as they appear in a certificate.
Each pair in the list has a type and a value.
\sa issuerInfo for an unordered version
\sa subjectInfoOrdered for the ordered information on the subject
\sa CertificateInfoPair for the elements in the list
*/
CertificateInfoOrdered issuerInfoOrdered() const;
/**
The constraints that apply to this certificate
*/
Constraints constraints() const;
/**
The policies that apply to this certificate
Policies are specified as strings containing OIDs
*/
QStringList policies() const;
/**
List of URI locations for CRL files
Each URI refers to the same CRL file
*/
QStringList crlLocations() const;
/**
List of URI locations for issuer certificate files
Each URI refers to the same issuer file
*/
QStringList issuerLocations() const;
/**
List of URI locations for OCSP services
*/
QStringList ocspLocations() const;
/**
The common name of the subject of the certificate
Common names are normally the name of a person, company or
organisation
*/
QString commonName() const;
/**
The serial number of the certificate
*/
BigInteger serialNumber() const;
/**
The public key associated with the subject of the certificate
*/
PublicKey subjectPublicKey() const;
/**
Test if the Certificate is valid as a Certificate Authority
\return true if the Certificate is valid as a Certificate Authority
*/
bool isCA() const;
/**
Test if the Certificate is self-signed
\return true if the certificate is self-signed
*/
bool isSelfSigned() const;
/**
Test if the Certificate has signed another Certificate
object and is therefore the issuer
\param other the certificate to test
\return true if this certificate is the issuer of the argument
*/
bool isIssuerOf(const Certificate &other) const;
/**
The upper bound of the number of links in the certificate
chain, if any
*/
int pathLimit() const;
/**
The signature algorithm used for the signature on this certificate
*/
SignatureAlgorithm signatureAlgorithm() const;
/**
The key identifier associated with the subject
*/
QByteArray subjectKeyId() const;
/**
The key identifier associated with the issuer
*/
QByteArray issuerKeyId() const;
/**
Check the validity of a certificate
\param trusted a collection of trusted certificates
\param untrusted a collection of additional certificates, not
necessarily trusted
\param u the use required for the certificate
\param vf the conditions to validate
\note This function may block
*/
Validity validate(const CertificateCollection &trusted, const CertificateCollection &untrusted, UsageMode u = UsageAny, ValidateFlags vf = ValidateAll) const;
/**
Export the Certificate into a DER format
*/
QByteArray toDER() const;
/**
Export the Certificate into a PEM format
*/
QString toPEM() const;
/**
Export the Certificate into PEM format in a file
\param fileName the name of the file to use
*/
bool toPEMFile(const QString &fileName) const;
/**
Import the certificate from DER
\param a the array containing the certificate in DER format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the Certificate corresponding to the certificate in the
provided array
*/
static Certificate fromDER(const QByteArray &a, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the certificate from PEM format
\param s the string containing the certificate in PEM format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the Certificate corresponding to the certificate in the
provided string
*/
static Certificate fromPEM(const QString &s, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the certificate from a file
\param fileName the name (and path, if required) of the file
containing the certificate in PEM format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the Certificate corresponding to the certificate in the
provided string
*/
static Certificate fromPEMFile(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
/**
Test if the subject of the certificate matches a specified host
name
This will return true (indicating a match), if the specified host
name meets the RFC 2818 validation rules with this certificate.
If the host is an internationalized domain name, then it must be
provided in unicode format, not in IDNA ACE/punycode format.
\param host the name of the host to compare to
*/
bool matchesHostName(const QString &host) const;
/**
Test for equality of two certificates
\param a the certificate to compare this certificate with
\return true if the two certificates are the same
*/
bool operator==(const Certificate &a) const;
/**
Inequality operator
\param other the certificate to compare this certificate with
*/
inline bool operator!=(const Certificate &other) const
{
return !(*this == other);
}
/**
\internal
\param c context (internal)
*/
void change(CertContext *c);
private:
class Private;
friend class Private;
QSharedDataPointer<Private> d;
friend class CertificateChain;
Validity chain_validate(const CertificateChain &chain, const CertificateCollection &trusted, const QList<CRL> &untrusted_crls, UsageMode u, ValidateFlags vf) const;
CertificateChain chain_complete(const CertificateChain &chain, const QList<Certificate> &issuers, Validity *result) const;
};
/**
\class CertificateChain qca_cert.h QtCrypto
A chain of related Certificates
CertificateChain is a list (a QList) of certificates that are related by
the signature from one to another. If Certificate C signs Certificate B,
and Certificate B signs Certificate A, then C, B and A form a chain.
The normal use of a CertificateChain is from a end-user Certificate (called
the primary, equivalent to QList::first()) through some intermediate
Certificates to some other Certificate (QList::last()), which might be a
root Certificate Authority, but does not need to be.
You can build up the chain using normal QList operations, such as
QList::append().
\sa QCA::CertificateCollection for an alternative way to represent a group
of Certificates that do not necessarily have a chained relationship.
\ingroup UserAPI
*/
class CertificateChain : public QList<Certificate>
{
public:
/**
Create an empty certificate chain
*/
inline CertificateChain() {}
/**
Create a certificate chain, starting at the specified certificate
\param primary the end-user certificate that forms one end of the
chain
*/
inline CertificateChain(const Certificate &primary) { append(primary); }
/**
Return the primary (end-user) Certificate
*/
inline const Certificate & primary() const { return first(); }
/**
Check the validity of a certificate chain
\param trusted a collection of trusted certificates
\param untrusted_crls a list of additional CRLs, not necessarily
trusted
\param u the use required for the primary certificate
\param vf the conditions to validate
\note This function may block
\sa Certificate::validate()
*/
inline Validity validate(const CertificateCollection &trusted, const QList<CRL> &untrusted_crls = QList<CRL>(), UsageMode u = UsageAny, ValidateFlags vf = ValidateAll) const;
/**
Complete a certificate chain for the primary certificate, using the
rest of the certificates in the chain object, as well as those in
\a issuers, as possible issuers in the chain. If there are issuers
missing, then the chain might be incomplete (at the worst case, if
no issuers exist for the primary certificate, then the resulting
chain will consist of just the primary certificate). Use the
\a result argument to find out if there was a problem during
completion. A result of ValidityGood means the chain was completed
successfully.
The newly constructed CertificateChain is returned.
If the certificate chain is empty, then this will return an empty
CertificateChain object.
\param issuers a pool of issuers to draw from as necessary
\param result the result of the completion operation
\note This function may block
\sa validate
*/
inline CertificateChain complete(const QList<Certificate> &issuers = QList<Certificate>(), Validity *result = 0) const;
};
inline Validity CertificateChain::validate(const CertificateCollection &trusted, const QList<CRL> &untrusted_crls, UsageMode u, ValidateFlags vf) const
{
if(isEmpty())
return ErrorValidityUnknown;
return first().chain_validate(*this, trusted, untrusted_crls, u, vf);
}
inline CertificateChain CertificateChain::complete(const QList<Certificate> &issuers, Validity *result) const
{
if(isEmpty())
return CertificateChain();
return first().chain_complete(*this, issuers, result);
}
/**
\class CertificateRequest qca_cert.h QtCrypto
%Certificate Request
A CertificateRequest is a unsigned request for a Certificate
\ingroup UserAPI
*/
class QCA_EXPORT CertificateRequest : public Algorithm
{
public:
/**
Create an empty certificate request
*/
CertificateRequest();
/**
Create a certificate request based on the contents of a file
\param fileName the file (and path, if necessary) containing a PEM
encoded certificate request
*/
CertificateRequest(const QString &fileName);
/**
Create a certificate request based on specified options
\param opts the options to use in the certificate request
\param key the private key that matches the certificate being
requested
\param provider the provider to use, if a specific provider is
required
*/
CertificateRequest(const CertificateOptions &opts, const PrivateKey &key, const QString &provider = QString());
/**
Standard copy constructor
\param from the request to copy from
*/
CertificateRequest(const CertificateRequest &from);
~CertificateRequest();
/**
Standard assignment operator
\param from the request to assign from
*/
CertificateRequest & operator=(const CertificateRequest &from);
/**
test if the certificate request is empty
\return true if the certificate request is empty, otherwise false
*/
bool isNull() const;
/**
Test if the certificate request can use a specified format
\param f the format to test for
\param provider the provider to use, if a specific provider is
required
\return true if the certificate request can use the specified
format
*/
static bool canUseFormat(CertificateRequestFormat f, const QString &provider = QString());
/**
the format that this Certificate request is in
*/
CertificateRequestFormat format() const;
/**
Information on the subject of the certificate being requested
\note this only applies to PKCS#10 format certificate requests
\sa subjectInfoOrdered for a version that maintains order
in the subject information.
*/
CertificateInfo subjectInfo() const;
/**
Information on the subject of the certificate being requested, as
an ordered list (QList of CertificateInfoPair).
\note this only applies to PKCS#10 format certificate requests
\sa subjectInfo for a version that does not maintain order, but
allows access based on a multimap.
\sa CertificateInfoPair for the elements in the list
*/
CertificateInfoOrdered subjectInfoOrdered() const;
/**
The constraints that apply to this certificate request
\note this only applies to PKCS#10 format certificate requests
*/
Constraints constraints() const;
/**
The policies that apply to this certificate request
\note this only applies to PKCS#10 format certificate requests
*/
QStringList policies() const;
/**
The public key belonging to the issuer
*/
PublicKey subjectPublicKey() const;
/**
Test if this Certificate Request is for a Certificate Authority
certificate
\note this only applies to PKCS#10 format certificate requests
*/
bool isCA() const;
/**
The path limit for the certificate in this Certificate Request
\note this only applies to PKCS#10 format certificate requests
*/
int pathLimit() const;
/**
The challenge associated with this certificate request
*/
QString challenge() const;
/**
The algorithm used to make the signature on this certificate
request
*/
SignatureAlgorithm signatureAlgorithm() const;
/**
Test for equality of two certificate requests
\param csr the certificate request to be compared to this certificate request
\return true if the two certificate requests are the same
*/
bool operator==(const CertificateRequest &csr) const;
/**
Inequality operator
\param other the certificate request to be compared to this certificate request
*/
inline bool operator!=(const CertificateRequest &other) const
{
return !(*this == other);
}
/**
Export the Certificate Request into a DER format
\note this only applies to PKCS#10 format certificate requests
*/
QByteArray toDER() const;
/**
Export the Certificate Request into a PEM format
\note this only applies to PKCS#10 format certificate requests
*/
QString toPEM() const;
/**
Export the Certificate into PEM format in a file
\param fileName the name of the file to use
\note this only applies to PKCS#10 format certificate requests
*/
bool toPEMFile(const QString &fileName) const;
/**
Import the certificate request from DER
\param a the array containing the certificate request in DER format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateRequest corresponding to the certificate
request in the provided array
\note this only applies to PKCS#10 format certificate requests
*/
static CertificateRequest fromDER(const QByteArray &a, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the certificate request from PEM format
\param s the string containing the certificate request in PEM
format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateRequest corresponding to the certificate
request in the provided string
\note this only applies to PKCS#10 format certificate requests
*/
static CertificateRequest fromPEM(const QString &s, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the certificate request from a file
\param fileName the name (and path, if required) of the file
containing the certificate request in PEM format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateRequest corresponding to the certificate
request in the provided string
\note this only applies to PKCS#10 format certificate requests
*/
static CertificateRequest fromPEMFile(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
/**
Export the CertificateRequest to a string
\return the string corresponding to the certificate request
\note this only applies to SPKAC format certificate requests
*/
QString toString() const;
/**
Import the CertificateRequest from a string
\param s the string containing to the certificate request
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateRequest corresponding to the certificate
request in the provided string
\note this only applies to SPKAC format certificate requests
*/
static CertificateRequest fromString(const QString &s, ConvertResult *result = 0, const QString &provider = QString());
/**
\internal
\param c context (internal)
*/
void change(CSRContext *c);
private:
class Private;
friend class Private;
QSharedDataPointer<Private> d;
};
/**
\class CRLEntry qca_cert.h QtCrypto
Part of a CRL representing a single certificate
\ingroup UserAPI
*/
class QCA_EXPORT CRLEntry
{
public:
/**
The reason why the certificate has been revoked
*/
enum Reason
{
Unspecified, ///< reason is unknown
KeyCompromise, ///< private key has been compromised
CACompromise, ///< certificate authority has been compromised
AffiliationChanged,
Superseded, ///< certificate has been superseded
CessationOfOperation,
CertificateHold, ///< certificate is on hold
RemoveFromCRL, ///< certificate was previously in a CRL, but is now valid
PrivilegeWithdrawn,
AACompromise ///< attribute authority has been compromised
};
/**
create an empty CRL entry
*/
CRLEntry();
/**
create a CRL entry
\param c the certificate to revoke
\param r the reason that the certificate is being revoked
*/
explicit CRLEntry(const Certificate &c, Reason r = Unspecified);
/**
create a CRL entry
\param serial the serial number of the Certificate being revoked
\param time the time the Certificate was revoked (or will be
revoked)
\param r the reason that the certificate is being revoked
*/
CRLEntry(const BigInteger serial, const QDateTime &time, Reason r = Unspecified);
/**
Copy constructor
\param from the CRLEntry to copy from
*/
CRLEntry(const CRLEntry &from);
~CRLEntry();
/**
Standard assignment operator
\param from the CRLEntry to copy from
*/
CRLEntry & operator=(const CRLEntry &from);
/**
The serial number of the certificate that is the subject of this CRL entry
*/
BigInteger serialNumber() const;
/**
The time this CRL entry was created
*/
QDateTime time() const;
/**
Test if this CRL entry is empty
*/
bool isNull() const;
/**
The reason that this CRL entry was created
Alternatively, you might like to think of this as the reason that
the subject certificate has been revoked
*/
Reason reason() const;
/**
Test if one CRL entry is "less than" another
CRL entries are compared based on their serial number
\param a the CRL entry to be compared to this CRL entry.
*/
bool operator<(const CRLEntry &a) const;
/**
Test for equality of two CRL Entries
\param a the CRL entry to be compared to this CRL entry.
\return true if the two certificates are the same
*/
bool operator==(const CRLEntry &a) const;
/**
Inequality operator
\param other the CRL entry to be compared to this CRL entry.
*/
inline bool operator!=(const CRLEntry &other) const
{
return !(*this == other);
}
private:
BigInteger _serial;
QDateTime _time;
Reason _reason;
class Private;
Private *d;
};
/**
\class CRL qca_cert.h QtCrypto
%Certificate Revocation List
A %CRL is a list of certificates that are special in some
way. The normal reason for including a certificate on a %CRL
is that the certificate should no longer be used. For
example, if a key is compromised, then the associated
certificate may no longer provides appropriate
security. There are other reasons why a certificate may be
placed on a %CRL, as shown in the CRLEntry::Reason
enumeration.
\sa CertificateCollection for a way to handle Certificates
and CRLs as a single entity.
\sa CRLEntry for the %CRL segment representing a single Certificate.
\ingroup UserAPI
*/
class QCA_EXPORT CRL : public Algorithm
{
public:
CRL();
/**
Standard copy constructor
\param from the revocation list to copy from
*/
CRL(const CRL &from);
~CRL();
/**
Standard assignment operator
\param from the revocation list to assign from
*/
CRL & operator=(const CRL &from);
/**
Test if the CRL is empty
\return true if the CRL is entry, otherwise return false
*/
bool isNull() const;
/**
Information on the issuer of the CRL as a QMultiMap.
\sa issuerInfoOrdered for a version that maintains the order
of information fields as per the underlying CRL.
*/
CertificateInfo issuerInfo() const;
/**
Information on the issuer of the CRL as an ordered list
(QList of CertificateInfoPair).
\sa issuerInfo for a version that allows lookup based on
a multimap.
\sa CertificateInfoPair for the elements in the list
*/
CertificateInfoOrdered issuerInfoOrdered() const;
/**
The CRL serial number. Note that serial numbers are a
CRL extension, and not all certificates have one.
\return the CRL serial number, or -1 if there is no serial number
*/
int number() const;
/**
the time that this CRL became (or becomes) valid
*/
QDateTime thisUpdate() const;
/**
the time that this CRL will be obsoleted
you should obtain an updated CRL at this time
*/
QDateTime nextUpdate() const;
/**
a list of the revoked certificates in this CRL
*/
QList<CRLEntry> revoked() const;
/**
The signature algorithm used for the signature on this CRL
*/
SignatureAlgorithm signatureAlgorithm() const;
/**
The key identification of the CRL issuer
*/
QByteArray issuerKeyId() const;
/**
Test for equality of two %Certificate Revocation Lists
\param a the CRL to be compared to this CRL
\return true if the two CRLs are the same
*/
bool operator==(const CRL &a) const;
/**
Inequality operator
\param other the CRL to be compared to this CRL
*/
inline bool operator!=(const CRL &other) const
{
return !(*this == other);
}
/**
Export the %Certificate Revocation List (CRL) in DER format
\return an array containing the CRL in DER format
*/
QByteArray toDER() const;
/**
Export the %Certificate Revocation List (CRL) in PEM format
\return a string containing the CRL in PEM format
*/
QString toPEM() const;
/**
Export the %Certificate Revocation List (CRL) into PEM format in a
file
\param fileName the name of the file to use
*/
bool toPEMFile(const QString &fileName) const;
/**
Import a DER encoded %Certificate Revocation List (CRL)
\param a the array containing the CRL in DER format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CRL corresponding to the contents of the array
*/
static CRL fromDER(const QByteArray &a, ConvertResult *result = 0, const QString &provider = QString());
/**
Import a PEM encoded %Certificate Revocation List (CRL)
\param s the string containing the CRL in PEM format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CRL corresponding to the contents of the string
*/
static CRL fromPEM(const QString &s, ConvertResult *result = 0, const QString &provider = QString());
/**
Import a PEM encoded %Certificate Revocation List (CRL) from a file
\param fileName the name (and path, if required) of the file
containing the certificate in PEM format
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CRL in the file
*/
static CRL fromPEMFile(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
/**
\internal
\param c context (internal)
*/
void change(CRLContext *c);
private:
class Private;
friend class Private;
QSharedDataPointer<Private> d;
};
/**
\class CertificateCollection qca_cert.h QtCrypto
Bundle of Certificates and CRLs
CertificateCollection provides a bundle of Certificates and Certificate
Revocation Lists (CRLs), not necessarily related.
\sa QCA::CertificateChain for a representation of a chain of Certificates
related by signatures.
\ingroup UserAPI
*/
class QCA_EXPORT CertificateCollection
{
public:
/**
Create an empty Certificate / CRL collection
*/
CertificateCollection();
/**
Standard copy constructor
\param from the CertificateCollection to copy from
*/
CertificateCollection(const CertificateCollection &from);
~CertificateCollection();
/**
Standard assignment operator
\param from the CertificateCollection to copy from
*/
CertificateCollection & operator=(const CertificateCollection &from);
/**
Append a Certificate to this collection
\param cert the Certificate to add to this CertificateCollection
*/
void addCertificate(const Certificate &cert);
/**
Append a CRL to this collection
\param crl the certificate revokation list to add to this
CertificateCollection
*/
void addCRL(const CRL &crl);
/**
The Certificates in this collection
*/
QList<Certificate> certificates() const;
/**
The CRLs in this collection
*/
QList<CRL> crls() const;
/**
Add another CertificateCollection to this collection
\param other the CertificateCollection to add to this collection
*/
void append(const CertificateCollection &other);
/**
Add another CertificateCollection to this collection
\param other the CertificateCollection to add to this collection
*/
CertificateCollection operator+(const CertificateCollection &other) const;
/**
Add another CertificateCollection to this collection
\param other the CertificateCollection to add to this collection
*/
CertificateCollection & operator+=(const CertificateCollection &other);
/**
test if the CertificateCollection can be imported and exported to
PKCS#7 format
\param provider the provider to use, if a specific provider is
required
\return true if the CertificateCollection can be imported and
exported to PKCS#7 format
*/
static bool canUsePKCS7(const QString &provider = QString());
/**
export the CertificateCollection to a plain text file
\param fileName the name (and path, if required) to write the
contents of the CertificateCollection to
\return true if the export succeeded, otherwise false
*/
bool toFlatTextFile(const QString &fileName);
/**
export the CertificateCollection to a PKCS#7 file
\param fileName the name (and path, if required) to write the
contents of the CertificateCollection to
\param provider the provider to use, if a specific provider is
required
\return true if the export succeeded, otherwise false
*/
bool toPKCS7File(const QString &fileName, const QString &provider = QString());
/**
import a CertificateCollection from a text file
\param fileName the name (and path, if required) to read the
certificate collection from
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateCollection corresponding to the contents of
the file specified in fileName
*/
static CertificateCollection fromFlatTextFile(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
/**
import a CertificateCollection from a PKCS#7 file
\param fileName the name (and path, if required) to read the
certificate collection from
\param result a pointer to a ConvertResult, which if not-null will
be set to the conversion status
\param provider the provider to use, if a specific provider is
required
\return the CertificateCollection corresponding to the contents of
the file specified in fileName
*/
static CertificateCollection fromPKCS7File(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
\class CertificateAuthority qca_cert.h QtCrypto
A %Certificate Authority is used to generate Certificates and
%Certificate Revocation Lists (CRLs).
\ingroup UserAPI
*/
class QCA_EXPORT CertificateAuthority : public Algorithm
{
public:
/**
Create a new %Certificate Authority
\param cert the CA certificate
\param key the private key associated with the CA certificate
\param provider the provider to use, if a specific provider is
required
*/
CertificateAuthority(const Certificate &cert, const PrivateKey &key, const QString &provider);
/**
Copy constructor
\param from the CertificateAuthority to copy from
*/
CertificateAuthority(const CertificateAuthority &from);
~CertificateAuthority();
/**
Standard assignment operator
\param from the CertificateAuthority to copy from
*/
CertificateAuthority & operator=(const CertificateAuthority &from);
/**
The Certificate belonging to the %CertificateAuthority
This is the Certificate that was passed as an argument to the
constructor
*/
Certificate certificate() const;
/**
Create a new Certificate by signing the provider CertificateRequest
\param req the CertificateRequest to sign
\param notValidAfter the last date that the Certificate will be
valid
*/
Certificate signRequest(const CertificateRequest &req, const QDateTime ¬ValidAfter) const;
/**
Create a new Certificate
\param key the Public Key to use to create the Certificate
\param opts the options to use for the new Certificate
*/
Certificate createCertificate(const PublicKey &key, const CertificateOptions &opts) const;
/**
Create a new Certificate Revocation List (CRL)
\param nextUpdate the date that the CRL will be updated
\return an empty CRL
*/
CRL createCRL(const QDateTime &nextUpdate) const;
/**
Update the CRL to include new entries
\param crl the CRL to update
\param entries the entries to add to the CRL
\param nextUpdate the date that this CRL will be updated
\return the update CRL
*/
CRL updateCRL(const CRL &crl, const QList<CRLEntry> &entries, const QDateTime &nextUpdate) const;
private:
class Private;
Private *d;
};
/**
\class KeyBundle qca_cert.h QtCrypto
Certificate chain and private key pair
KeyBundle is essentially a convience class that holds a
certificate chain and an associated private key. This class
has a number of methods that make it particularly suitable
for accessing a PKCS12 (.p12) format file, however it can
be used as just a container for a Certificate, its
associated PrivateKey and optionally additional
X.509 Certificate that form a chain.
For more information on PKCS12 "Personal Information
Exchange Syntax Standard", see <a
href="ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-12/pkcs-12v1.pdf">ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-12/pkcs-12v1.pdf</a>.
\ingroup UserAPI
*/
class QCA_EXPORT KeyBundle
{
public:
/**
Create an empty KeyBundle
*/
KeyBundle();
/**
Create a KeyBundle from a PKCS12 (.p12) encoded
file
This constructor requires appropriate plugin (provider)
support. You must check for the "pkcs12" feature
before using this constructor.
\param fileName the name of the file to read from
\param passphrase the passphrase that is applicable to the file
\sa fromFile for a more flexible version of the
same capability.
\note This synchronous operation may require event handling, and so
it must not be called from the same thread as an EventHandler.
*/
explicit KeyBundle(const QString &fileName, const SecureArray &passphrase = SecureArray());
/**
Standard copy constructor
\param from the KeyBundle to use as source
*/
KeyBundle(const KeyBundle &from);
~KeyBundle();
/**
Standard assignment operator
\param from the KeyBundle to use as source
*/
KeyBundle & operator=(const KeyBundle &from);
/**
Test if this key is empty (null)
*/
bool isNull() const;
/**
The name associated with this key.
This is also known as the "friendly name", and if
present, is typically suitable to be displayed to
the user.
\sa setName
*/
QString name() const;
/**
The public certificate part of this bundle
\sa setCertificateChainAndKey
*/
CertificateChain certificateChain() const;
/**
The private key part of this bundle
\sa setCertificateChainAndKey
*/
PrivateKey privateKey() const;
/**
Specify the name of this bundle
\param s the name to use
*/
void setName(const QString &s);
/**
Set the public certificate and private key
\param c the CertificateChain containing the public part of the
Bundle
\param key the private key part of the Bundle
\sa privateKey, certificateChain for getters
*/
void setCertificateChainAndKey(const CertificateChain &c, const PrivateKey &key);
/**
Export the key bundle to an array in PKCS12 format.
This method requires appropriate plugin (provider)
support - you must check for the "pkcs12" feature,
as shown below.
\code
if( QCA::isSupported("pkcs12") )
{
// can use I/O
byteArray = bundle.toArray( "pass phrase" );
}
else
{
// not possible to use I/O
}
\endcode
\param passphrase the passphrase to use to protect the bundle
\param provider the provider to use, if a specific provider is
required
*/
QByteArray toArray(const SecureArray &passphrase, const QString &provider = QString()) const;
/**
Export the key bundle to a file in PKCS12 (.p12) format
This method requires appropriate plugin (provider)
support - you must check for the "pkcs12" feature,
as shown below.
\code
if( QCA::isSupported("pkcs12") )
{
// can use I/O
bool result = bundle.toFile( filename, "pass phrase" );
}
else
{
// not possible to use I/O
}
\endcode
\param fileName the name of the file to save to
\param passphrase the passphrase to use to protect the bundle
\param provider the provider to use, if a specific provider is
required
*/
bool toFile(const QString &fileName, const SecureArray &passphrase, const QString &provider = QString()) const;
/**
Import the key bundle from an array in PKCS12 format
This method requires appropriate plugin (provider)
support - you must check for the "pkcs12" feature,
as shown below.
\code
if( QCA::isSupported("pkcs12") )
{
// can use I/O
bundle = QCA::KeyBundle::fromArray( array, "pass phrase" );
}
else
{
// not possible to use I/O
}
\endcode
\param a the array to import from
\param passphrase the passphrase for the encoded bundle
\param result pointer to the result of the import process
\param provider the provider to use, if a specific provider is
required
\sa QCA::KeyLoader for an asynchronous loader approach.
\note This synchronous operation may require event handling, and so
it must not be called from the same thread as an EventHandler.
*/
static KeyBundle fromArray(const QByteArray &a, const SecureArray &passphrase = SecureArray(), ConvertResult *result = 0, const QString &provider = QString());
/**
Import the key bundle from a file in PKCS12 (.p12) format
This method requires appropriate plugin (provider)
support - you must check for the "pkcs12" feature,
as shown below.
\code
if( QCA::isSupported("pkcs12") )
{
// can use I/O
bundle = QCA::KeyBundle::fromFile( filename, "pass phrase" );
}
else
{
// not possible to use I/O
}
\endcode
\param fileName the name of the file to read from
\param passphrase the passphrase for the encoded bundle
\param result pointer to the result of the import process
\param provider the provider to use, if a specific provider is
required
\sa QCA::KeyLoader for an asynchronous loader approach.
\note This synchronous operation may require event handling, and so
it must not be called from the same thread as an EventHandler.
*/
static KeyBundle fromFile(const QString &fileName, const SecureArray &passphrase = SecureArray(), ConvertResult *result = 0, const QString &provider = QString());
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
\class PGPKey qca_cert.h QtCrypto
Pretty Good Privacy key
This holds either a reference to an item in a real PGP keyring,
or a standalone item created using the from*() functions.
Note that with the latter method, the key is of no use besides
being informational. The key must be in a keyring
(that is, inKeyring() == true) to actually do crypto with it.
\ingroup UserAPI
*/
class QCA_EXPORT PGPKey : public Algorithm
{
public:
/**
Create an empty PGP key
*/
PGPKey();
/**
Create a PGP key from an encoded file
\param fileName the name (and path, if required) of the file
that the PGP key is to be loaded from.
\sa fromFile for a version that allows better error checking / validation
\sa toFile for a method to write out the key.
*/
PGPKey(const QString &fileName);
/**
Standard copy constructor
\param from the PGPKey to use as the source
*/
PGPKey(const PGPKey &from);
~PGPKey();
/**
Standard assignment operator
\param from the PGPKey to use as the source
*/
PGPKey & operator=(const PGPKey &from);
/**
Test if the PGP key is empty (null)
\return true if the PGP key is null
*/
bool isNull() const;
/**
The Key identification for the PGP key
*/
QString keyId() const;
/**
The primary user identification for the key
*/
QString primaryUserId() const;
/**
The list of all user identifications associated with the key
*/
QStringList userIds() const;
/**
Test if the PGP key is the secret key
\return true if the PGP key is the secret key
*/
bool isSecret() const;
/**
The creation date for the key
*/
QDateTime creationDate() const;
/**
The expiration date for the key
*/
QDateTime expirationDate() const;
/**
The key fingerpint
This will return the PGP fingerprint as a string. It comprises 40
hex digits, without spaces.
*/
QString fingerprint() const;
/**
Test if this key is in a keyring
\return true if the key is in a keyring
\note keys that are not in a keyring cannot be used for encryption,
decryption, signing or verification
*/
bool inKeyring() const;
/**
Test if the key is trusted
\return true if the key is trusted
*/
bool isTrusted() const;
/**
Export the key to an array.
This will export the key in a binary format (that is, not in an
"ascii armoured" form).
\sa fromArray for a static import method.
\sa toString for an "ascii armoured" export method.
*/
QByteArray toArray() const;
/**
Export the key to a string
This will export the key in an "ascii armoured" form.
\sa fromString for a static import method.
\sa toArray for a binary format export method.
*/
QString toString() const;
/**
Export the key to a file
\param fileName the name of the file to save the key to
*/
bool toFile(const QString &fileName) const;
/**
Import the key from an array
\param a the array to import from
\param result if not null, this will be set to the result of the
import process
\param provider the provider to use, if a particular provider is
required
*/
static PGPKey fromArray(const QByteArray &a, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the key from a string
\param s the string to import from
\param result if not null, this will be set to the result of the
import process
\param provider the provider to use, if a particular provider is
required
*/
static PGPKey fromString(const QString &s, ConvertResult *result = 0, const QString &provider = QString());
/**
Import the key from a file
\param fileName string containing the name of the file to import
from
\param result if not null, this will be set to the result of the
import process
\param provider the provider to use, if a particular provider is
required
*/
static PGPKey fromFile(const QString &fileName, ConvertResult *result = 0, const QString &provider = QString());
private:
class Private;
Private *d;
};
/**
\class KeyLoader qca_cert.h QtCrypto
Asynchronous private key loader
GUI applications generally must use KeyLoader to load private keys. This
is because the synchronous private key loading functions, for example
QCA::PrivateKey::fromPEMFile(), cannot be used within the same thread as an
EventHandler, and most GUI applications will use EventHandler from the main
thread. KeyLoader does not have this problem. It can be used from any
thread, including the same thread as EventHandler.
The KeyLoader class allows you to asynchronously load stand-alone private
keys (QCA::PrivateKey) or private keys with a certificate (QCA::KeyBundle)
with a signal that advises of completion.
To use this class to load a PrivateKey, you create a KeyLoader object then
use one of the loadPrivateKeyFrom...() functions, depending on the format
for your key. These functions return immediately. When you get the
finished() signal, you can check that the loading operation succeeded
(using convertResult()) and then obtain the PrivateKey using the
privateKey() function.
The same process applies for loading a KeyBundle, except that you use
either loadKeyBundleFromFile() or loadKeyBundleFromArray() instead of the
loadPrivateKeyFrom...() function, and use keyBundle() instead of
privateKey().
The loader may need a passphrase to complete the loading of the key or key
bundle. You should use the QCA::EventHandler class to ensure that you deal
with this correctly.
\note %QCA also provides synchronous private key loading using
QCA::PrivateKey::fromPEMFile(), QCA::PrivateKey::fromPEM() and
QCA::PrivateKey::fromDER(). %QCA provides synchronous key bundle loading
using QCA::KeyBundle::fromArray() and QCA::KeyBundle::fromFile().
\ingroup UserAPI
*/
class QCA_EXPORT KeyLoader : public QObject
{
Q_OBJECT
public:
/**
Create a KeyLoader object.
\param parent the parent object for this object
*/
KeyLoader(QObject *parent = 0);
~KeyLoader();
/**
Initiate an asynchronous loading of a PrivateKey from a PEM format
file.
This function will return immediately.
\param fileName the name of the file (and path, if necessary) to
load the key from
*/
void loadPrivateKeyFromPEMFile(const QString &fileName);
/**
Initiate an asynchronous loading of a PrivateKey from a PEM format
string.
This function will return immediately.
\param s the string containing the PEM formatted key
*/
void loadPrivateKeyFromPEM(const QString &s);
/**
Initiate an asynchronous loading of a PrivateKey from a DER format
array.
This function will return immediately.
\param a the array containing the DER formatted key
*/
void loadPrivateKeyFromDER(const SecureArray &a);
/**
Initiate an asynchronous loading of a KeyBundle from a file
This function will return immediately.
\param fileName the name of the file (and path, if necessary) to
load the key bundle from
*/
void loadKeyBundleFromFile(const QString &fileName);
/**
Initiate an asynchronous loading of a KeyBundle from an array
This function will return immediately.
\param a the array containing the key bundle
*/
void loadKeyBundleFromArray(const QByteArray &a);
/**
The result of the loading process.
This is not valid until the finished() signal has been emitted.
*/
ConvertResult convertResult() const;
/**
The private key that has been loaded.
This is only valid if loadPrivateKeyFromPEMFile(),
loadPrivateKeyFromPEM() or loadPrivateKeyFromDER() has been used,
the load has completed (that is, finished() has been emitted), and
the conversion succeeded (that is, convertResult() returned
ConvertGood).
*/
PrivateKey privateKey() const;
/**
The key bundle that has been loaded.
This is only valid if loadKeyBundleFromFile() or
loadKeyBundleFromArray() has been used, the load has completed
(that is, finished() has been emitted), and the conversion
succeeded (that is, convertResult() returned ConvertGood).
*/
KeyBundle keyBundle() const;
Q_SIGNALS:
/**
Signal that is emitted when the load process has completed.
\note The load process may not have completed successfully - check
the result of convertResult() to confirm this before using the
privateKey() or keyBundle() results.
*/
void finished();
private:
Q_DISABLE_COPY(KeyLoader)
class Private;
friend class Private;
Private *d;
};
}
#endif
|