/usr/include/isds.h is in libisds-dev 0.10.6-1+b1.
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 | #ifndef __ISDS_ISDS_H__
#define __ISDS_ISDS_H__
/* Public interface for libisds.
* Private declarations in isds_priv.h. */
#include <stdlib.h> /* For size_t */
#include <time.h> /* For struct tm */
#include <sys/time.h> /* For struct timeval */
#include <libxml/tree.h> /* For xmlDoc and xmlNodePtr */
#ifdef __cplusplus /* For C++ linker sake */
extern "C" {
#endif
/* _deprecated macro marks library symbols as deprecated. Application should
* avoid using such function as soon as possible. */
#if defined(__GNUC__)
#define _deprecated __attribute__((deprecated))
#else
#define _deprecated
#endif
/* Service locators */
/* Base URL of production ISDS instance */
extern const char isds_locator[]; /* Without client certificate auth. */
extern const char isds_cert_locator[]; /* With client certificate auth. */
extern const char isds_otp_locator[]; /* With OTP authentication */
/* Base URL of testing ISDS instance */
extern const char isds_testing_locator[]; /* Without client certificate */
extern const char isds_cert_testing_locator[]; /* With client certificate */
extern const char isds_otp_testing_locator[]; /* With OTP authentication */
struct isds_ctx; /* Context for specific ISDS box */
typedef enum {
IE_SUCCESS = 0, /* No error, just for C convenience (0 means Ok) */
IE_ERROR, /* Unspecified error */
IE_NOTSUP,
IE_INVAL,
IE_INVALID_CONTEXT,
IE_NOT_LOGGED_IN,
IE_CONNECTION_CLOSED,
IE_TIMED_OUT,
IE_NOEXIST,
IE_NOMEM,
IE_NETWORK,
IE_HTTP,
IE_SOAP,
IE_XML,
IE_ISDS,
IE_ENUM,
IE_DATE,
IE_2BIG,
IE_2SMALL,
IE_NOTUNIQ,
IE_NOTEQUAL,
IE_PARTIAL_SUCCESS,
IE_ABORTED,
IE_SECURITY
} isds_error;
typedef enum {
ILL_NONE = 0,
ILL_CRIT = 10,
ILL_ERR = 20,
ILL_WARNING = 30,
ILL_INFO = 40,
ILL_DEBUG = 50,
ILL_ALL = 100
} isds_log_level;
typedef enum {
ILF_NONE = 0x0,
ILF_HTTP = 0x1,
ILF_SOAP = 0x2,
ILF_ISDS = 0x4,
ILF_FILE = 0x8,
ILF_SEC = 0x10,
ILF_XML = 0x20,
ILF_ALL = 0xFF
} isds_log_facility;
/* Return text description of ISDS error */
const char *isds_strerror(const isds_error error);
/* libisds options */
typedef enum {
IOPT_TLS_VERIFY_SERVER, /* _Bool: Verify server identity?
Default value is true. */
IOPT_TLS_CA_FILE, /* char *: File name with CA certificates.
Default value depends on cryptographic
library. */
IOPT_TLS_CA_DIRECTORY, /* char *: Directory name with CA certificates.
Default value depends on cryptographic
library. */
IOPT_TLS_CRL_FILE, /* char *: File name with CRL in PEM format.
Default value depends on cryptographic
library. */
IOPT_NORMALIZE_MIME_TYPE, /* _Bool: Normalize MIME type values?
Default value is false. */
} isds_option;
/* TLS libisds options */
typedef enum {
ITLS_VERIFY_SERVER, /* _Bool: Verify server identity? */
ITLS_CA_FILE, /* char *: File name with CA certificates */
ITLS_CA_DIRECTORY, /* char *: Directory name with CA certificates */
ITLS_CRL_FILE /* char *: File name with CRL in PEM format */
} isds_tls_option;
/* Cryptographic material encoding */
typedef enum {
PKI_FORMAT_PEM, /* PEM format */
PKI_FORMAT_DER, /* DER format */
PKI_FORMAT_ENG /* Stored in crypto engine */
} isds_pki_format;
/* Public key crypto material to authenticate client */
struct isds_pki_credentials {
char *engine; /* String identifier of crypto engine to use
(where key is stored). Use NULL for no engine */
isds_pki_format certificate_format; /* Certificate format */
char *certificate; /* Path to client certificate, or certificate
nickname in case of NSS as curl back-end,
or key slot identifier inside crypto engine.
Some crypto engines can pair certificate with
key automatically (NULL value) */
isds_pki_format key_format; /* Private key format */
char *key; /* Path to client private key, or key identifier
in case of used engine */
char *passphrase; /* Zero terminated string with password for
decrypting private key, or engine PIN.
Use NULL for no pass-phrase or question by
engine. */
};
/* One-time password authentication method */
typedef enum {
OTP_HMAC = 0, /* HMAC-based OTP method */
OTP_TIME /* Time-based OTP method */
} isds_otp_method;
/* One-time passwed authentication resolution */
typedef enum {
OTP_RESOLUTION_SUCCESS = 0, /* Authentication succeded */
OTP_RESOLUTION_UNKNOWN, /* Status is unkown */
OTP_RESOLUTION_BAD_AUTHENTICATION, /* Bad log-in, retry */
OTP_RESOLUTION_ACCESS_BLOCKED, /* Access blocked for 60 minutes
(brute force attack detected) */
OTP_RESOLUTION_PASSWORD_EXPIRED, /* Password has expired.
???: OTP or regular password
expired? */
OTP_RESOLUTION_TO_FAST, /* OTP cannot be sent repeatedly
at this rate (minimal delay
depends on TOTP window setting) */
OTP_RESOLUTION_UNAUTHORIZED, /* User name is not allowed to
access requested URI */
OTP_RESOLUTION_TOTP_SENT, /* OTP has been generated and sent by
ISDS */
OTP_RESOLUTION_TOTP_NOT_SENT, /* OTP could not been sent.
Retry later. */
} isds_otp_resolution;
/* One-time password to authenticate client */
struct isds_otp {
/* Input members */
isds_otp_method method; /* Select OTP method to use */
char *otp_code; /* One-time password to use. Pass NULL,
if you do not know it yet (e.g. in case
of first phase of time-based OTP to
request new code from ISDS.) */
/* Output members */
isds_otp_resolution resolution; /* Fine-grade resolution of OTP
authentication attempt. */
};
/* Box type */
typedef enum {
DBTYPE_SYSTEM = 0, /* This is special sender value for messages
sent by ISDS. */
DBTYPE_OVM = 10,
DBTYPE_OVM_NOTAR = 11,
DBTYPE_OVM_EXEKUT = 12,
DBTYPE_OVM_REQ = 13,
DBTYPE_PO = 20,
DBTYPE_PO_ZAK = 21,
DBTYPE_PO_REQ = 22,
DBTYPE_PFO = 30,
DBTYPE_PFO_ADVOK = 31,
DBTYPE_PFO_DANPOR = 32,
DBTYPE_PFO_INSSPR = 33,
DBTYPE_FO = 40
} isds_DbType;
/* Box status from point of view of accessibility */
typedef enum {
DBSTATE_ACCESSIBLE = 1,
DBSTATE_TEMP_UNACCESSIBLE = 2,
DBSTATE_NOT_YET_ACCESSIBLE = 3,
DBSTATE_PERM_UNACCESSIBLE = 4,
DBSTATE_REMOVED = 5,
DBSTATE_TEMP_UNACCESSIBLE_LAW = 6
} isds_DbState;
/* User permissions from point of view of ISDS.
* Instances can be bitmaps of any discrete values. */
typedef enum {
PRIVIL_READ_NON_PERSONAL = 0x1, /* Can download and read messages with
dmPersonalDelivery == false */
PRIVIL_READ_ALL = 0x2, /* Can download and read messages with
dmPersonalDelivery == true */
PRIVIL_CREATE_DM = 0x4, /* Can create and sent messages,
can download outgoing (sent) messages */
PRIVIL_VIEW_INFO = 0x8, /* Can list messages and data about
post and delivery */
PRIVIL_SEARCH_DB = 0x10, /* Can search for boxes */
PRIVIL_OWNER_ADM = 0x20, /* Can administer his box (add/remove
permitted users and theirs
permissions) */
PRIVIL_READ_VAULT = 0x40, /* Can read message stored in long term
storage (does not exists since
2012-05) */
PRIVIL_ERASE_VAULT = 0x80 /* Can delete messages from long term
storage */
} isds_priviledges;
/* Message status */
typedef enum {
MESSAGESTATE_SENT = 0x2, /* Message has been put into ISDS */
MESSAGESTATE_STAMPED = 0x4, /* Message stamped by TSA */
MESSAGESTATE_INFECTED = 0x8, /* Message included viruses,
infected document has been removed */
MESSAGESTATE_DELIVERED = 0x10, /* Message delivered
(dmDeliveryTime stored) */
MESSAGESTATE_SUBSTITUTED = 0x20, /* Message delivered through fiction,
dmAcceptanceTime stored */
MESSAGESTATE_RECEIVED = 0x40, /* Message accepted (by user log-in or
user explicit request),
dmAcceptanceTime stored */
MESSAGESTATE_READ = 0x80, /* Message has been read by user */
MESSAGESTATE_UNDELIVERABLE = 0x100, /* Message could not been delivered
(e.g. recipient box has been made
inaccessible meantime) */
MESSAGESTATE_REMOVED = 0x200, /* Message content deleted */
MESSAGESTATE_IN_SAFE = 0x400 /* Message stored in long term storage */
} isds_message_status;
#define MESSAGESTATE_ANY 0x7FE /* Union of all isds_message_status
values */
/* Hash algorithm types */
typedef enum {
HASH_ALGORITHM_MD5,
HASH_ALGORITHM_SHA_1,
HASH_ALGORITHM_SHA_224,
HASH_ALGORITHM_SHA_256,
HASH_ALGORITHM_SHA_384,
HASH_ALGORITHM_SHA_512,
} isds_hash_algorithm;
/* Buffer storage strategy.
* How function should embed application provided buffer into raw element of
* output structure. */
typedef enum {
BUFFER_DONT_STORE, /* Don't fill raw member */
BUFFER_COPY, /* Copy buffer content into newly allocated raw */
BUFFER_MOVE /* Just copy pointer.
But leave deallocation to isds_*_free(). */
} isds_buffer_strategy;
/* Hash value storage */
struct isds_hash {
isds_hash_algorithm algorithm; /* Hash algorithm */
size_t length; /* Hash value length in bytes */
void *value; /* Hash value */
};
/* Name of person */
struct isds_PersonName {
char *pnFirstName;
char *pnMiddleName;
char *pnLastName;
char *pnLastNameAtBirth;
};
/* Date and place of birth */
struct isds_BirthInfo {
struct tm *biDate; /* Date of Birth in local time at birth place,
only tm_year, tm_mon and tm_mday carry sane
value */
char *biCity;
char *biCounty; /* German: Bezirk, Czech: okres */
char *biState;
};
/* Post address */
struct isds_Address {
char *adCity;
char *adStreet;
char *adNumberInStreet;
char *adNumberInMunicipality;
char *adZipCode;
char *adState;
};
/* Data about box and his owner.
* NULL pointer means undefined value */
struct isds_DbOwnerInfo {
char *dbID; /* Box ID [Max. 7 chars] */
isds_DbType *dbType; /* Box Type */
char *ic; /* ID */
struct isds_PersonName *personName; /* Name of person */
char *firmName; /* Name of firm */
struct isds_BirthInfo *birthInfo; /* Birth of person */
struct isds_Address *address; /* Post address */
char *nationality;
char *email;
char *telNumber;
char *identifier; /* External box identifier for data
provider (OVM, PO, maybe PFO)
[Max. 20 chars] */
char *registryCode; /* PFO External registry code
[Max. 5 chars] */
long int *dbState; /* Box state; 1 <=> active box;
long int because xsd:integer
TODO: enum? */
_Bool *dbEffectiveOVM; /* Box has OVM role (§ 5a) */
_Bool *dbOpenAddressing; /* Non-OVM Box is free to receive
messages from anybody */
};
/* User type */
typedef enum {
USERTYPE_PRIMARY, /* Owner of the box */
USERTYPE_ENTRUSTED, /* User with limited access to the box */
USERTYPE_ADMINISTRATOR, /* User to manage ENTRUSTED_USERs */
USERTYPE_OFFICIAL, /* ??? */
USERTYPE_OFFICIAL_CERT, /* ??? */
USERTYPE_LIQUIDATOR /* Company liquidator */
} isds_UserType;
/* Data about user.
* NULL pointer means undefined value */
struct isds_DbUserInfo {
char *userID; /* User ID [Min. 6, max. 12 characters] */
isds_UserType *userType; /* User type */
long int *userPrivils; /* Set of user permissions */
struct isds_PersonName *personName; /* Name of the person */
struct isds_Address *address; /* Post address */
struct tm *biDate; /* Date of birth in local time,
only tm_year, tm_mon and tm_mday carry sane
value */
char *ic; /* ID of a supervising firm [Max. 8 chars] */
char *firmName; /* Name of a supervising firm
[Max. 100 chars] */
char *caStreet; /* Street and number of contact address */
char *caCity; /* Czech City of contact address */
char *caZipCode; /* Post office code of contact address */
char *caState; /* Abbreviated country of contact address;
Implicit value is "CZ"; Optional. */
};
/* Message event type */
typedef enum {
EVENT_UKNOWN, /* Event unknown to this library */
EVENT_ACCEPTED_BY_RECIPIENT, /* Message has been delivered and accepted
by recipient action */
EVENT_ACCEPTED_BY_FICTION, /* Message has been delivered, acceptance
timed out, considered as accepted */
EVENT_UNDELIVERABLE, /* Recipient box made inaccessible,
thus message is undeliverable */
EVENT_COMMERCIAL_ACCEPTED, /* Recipient confirmed acceptance of
commercial message */
EVENT_ENTERED_SYSTEM, /* Message entered ISDS, i.e. has been just
sent by sender */
EVENT_DELIVERED, /* Message has been delivered */
EVENT_PRIMARY_LOGIN, /* Primary user has logged in */
EVENT_ENTRUSTED_LOGIN, /* Entrusted user with capability to read
has logged in */
EVENT_SYSCERT_LOGIN /* Application authenticated by `system'
certificate has logged in */
} isds_event_type;
/* Message event
* All members are optional as specification states so. */
struct isds_event {
struct timeval *time; /* When the event occurred */
isds_event_type *type; /* Type of the event */
char *description; /* Human readable event description
generated by ISDS (Czech) */
};
/* Message envelope
* Be ware that the string length constraints are forced only on output
* members transmitted to ISDS. The other direction (downloaded from ISDS)
* can break these rules. It should not happen, but nobody knows how much
* incompatible new version of ISDS protocol will be. This is the gold
* Internet rule: be strict on what you put, be tolerant on what you get. */
struct isds_envelope {
/* Following members apply to incoming messages only: */
char *dmID; /* Message ID.
Maximal length is 20 characters. */
char *dbIDSender; /* Box ID of sender.
Special value "aaaaaaa" means sent by
ISDS.
Maximal length is 7 characters. */
char *dmSender; /* Sender name;
Maximal length is 100 characters. */
char *dmSenderAddress; /* Postal address of sender;
Maximal length is 100 characters. */
long int *dmSenderType; /* Gross Box type of sender
TODO: isds_DbType ? */
char *dmRecipient; /* Recipient name;
Maximal length is 100 characters. */
char *dmRecipientAddress; /* Postal address of recipient;
Maximal length is 100 characters. */
_Bool *dmAmbiguousRecipient; /* Recipient has OVM role */
/* Following members are assigned by ISDS in different phases of message
* life cycle. */
unsigned long int *dmOrdinal; /* Ordinal number in list of
incoming/outgoing messages */
isds_message_status *dmMessageStatus; /* Message state */
long int *dmAttachmentSize; /* Size of message documents in
kilobytes (rounded). */
struct timeval *dmDeliveryTime; /* Time of delivery into a box
NULL, if message has not been
delivered yet */
struct timeval *dmAcceptanceTime; /* Time of acceptance of the message
by an user. NULL if message has not
been accepted yet. */
struct isds_hash *hash; /* Message hash.
This is hash of isds:dmDM subtree. */
void *timestamp; /* Qualified time stamp; Optional. */
size_t timestamp_length; /* Length of timestamp in bytes */
struct isds_list *events; /* Events message passed trough;
List of isds_event's. */
/* Following members apply to both outgoing and incoming messages: */
char *dmSenderOrgUnit; /* Organisation unit of sender as string;
Optional. */
long int *dmSenderOrgUnitNum; /* Organisation unit of sender as number;
Optional. */
char *dbIDRecipient; /* Box ID of recipient; Mandatory.
Maximal length is 7 characters. */
char *dmRecipientOrgUnit; /* Organisation unit of recipient as
string; Optional. */
long int *dmRecipientOrgUnitNum; /* Organisation unit of recipient as
number; Optional. */
char *dmToHands; /* Person in recipient organisation;
Optional. */
char *dmAnnotation; /* Subject (title) of the message.
Maximal length is 255 characters. */
char *dmRecipientRefNumber; /* Czech: číslo jednací příjemce; Optional.
Maximal length is 50 characters. */
char *dmSenderRefNumber; /* Czech: číslo jednací odesílatele;
Optional. Maximal length is 50 chars. */
char *dmRecipientIdent; /* Czech: spisová značka příjemce; Optional.
Maximal length is 50 characters. */
char *dmSenderIdent; /* Czech: spisová značka odesílatele;
Optional. Maximal length is 50 chars. */
/* Act addressing in Czech Republic:
* Point (Paragraph) § Section Law/Year Coll. */
long int *dmLegalTitleLaw; /* Number of act mandating authority */
long int *dmLegalTitleYear; /* Year of act issue mandating authority */
char *dmLegalTitleSect; /* Section of act mandating authority.
Czech: paragraf */
char *dmLegalTitlePar; /* Paragraph of act mandating authority.
Czech: odstavec */
char *dmLegalTitlePoint; /* Point of act mandating authority.
Czech: písmeno */
_Bool *dmPersonalDelivery; /* If true, only person with higher
privileges can read this message */
_Bool *dmAllowSubstDelivery; /* Allow delivery through fiction.
I.e. Even if recipient did not read this
message, message is considered as
delivered after (currently) 10 days.
This is delivery through fiction.
Applies only to OVM dbType sender. */
char *dmType; /* Message type (commercial subtypes or
government message):
Input values (when sending a message):
"I" is commercial message offering
paying the response (initiatory
message);
it's necessary to define
dmSenderRefNumber
"K" is commercial message paid by sender
if this message
"O" is commercial response paid by
sender of initiatory message; it's
necessary to copy value from
dmSenderRefNumber of initiatory
message to dmRecipientRefNumber
of this message
"V" is noncommercial government message
Default value while sending is undefined
which has the same meaning as "V".
Output values (when retrieving
a message):
"A" is subsidized initiatory commercial
message which can pay a response
"B" is subsidized initiatory commercial
message which has already paid the
response
"C" is subsidized initiatory commercial
message where the response offer has
expired
"D" is externally subsidized commercial
messsage
"E" is commercial message prepaid by
a stamp
"G" is commerical message paid by
a sponsor
"I"
"K"
"O"
"V"
"X" is initiatory commercial message
where the response offer has expired
"Y" initiatory commercial message which
has already paid the response
"Z" is limitedly subsidized commercial
message
Length: Exactly 1 UTF-8 character if
defined; */
/* Following members apply to outgoing messages only: */
_Bool *dmOVM; /* OVM sending mode.
Non-OVM dbType boxes that has
dbEffectiveOVM == true MUST select
between true (OVM mode) and
false (non-OVM mode).
Optional; Implicit value is true. */
_Bool *dmPublishOwnID; /* Allow sender to express his name shall
be available to recipient by
isds_get_message_sender(). Sender type
will be always available.
Optional; Default value is false. */
};
/* Document type from point of hierarchy */
typedef enum {
FILEMETATYPE_MAIN, /* Main document */
FILEMETATYPE_ENCLOSURE, /* Appendix */
FILEMETATYPE_SIGNATURE, /* Digital signature of other document */
FILEMETATYPE_META /* XML document for ESS (electronic
document information system) purposes */
} isds_FileMetaType;
/* Document */
struct isds_document {
_Bool is_xml; /* True if document is ISDS XML document.
False if document is ISDS binary
document. */
xmlNodePtr xml_node_list; /* XML node-set presenting current XML
document content. This is pointer to
first node of the document in
isds_message.xml tree. Use `children'
and `next' members to iterate the
document.
It will be NULL if document is empty.
Valid only if is_xml is true. */
void *data; /* Document content.
The encoding and interpretation depends
on dmMimeType.
Valid only if is_xml is false. */
size_t data_length; /* Length of the data in bytes.
Valid only if is_xml is false. */
char *dmMimeType; /* MIME type of data; Mandatory. */
isds_FileMetaType dmFileMetaType; /* Document type to create hierarchy */
char *dmFileGuid; /* Message-local document identifier;
Optional. */
char *dmUpFileGuid; /* Reference to upper document identifier
(dmFileGuid); Optional. */
char *dmFileDescr; /* Document name (title). E.g. file name;
Mandatory. */
char *dmFormat; /* Reference to XML form definition;
Defines how to interpret XML document;
Optional. */
};
/* Raw message representation content type.
* This is necessary to distinguish between different representations without
* expensive repeated detection.
* Infix explanation:
* PLAIN_SIGNED data are XML with namespace mangled to signed alternative
* CMS_SIGNED data are XML with signed namespace encapsulated in CMS */
typedef enum {
RAWTYPE_INCOMING_MESSAGE,
RAWTYPE_PLAIN_SIGNED_INCOMING_MESSAGE,
RAWTYPE_CMS_SIGNED_INCOMING_MESSAGE,
RAWTYPE_PLAIN_SIGNED_OUTGOING_MESSAGE,
RAWTYPE_CMS_SIGNED_OUTGOING_MESSAGE,
RAWTYPE_DELIVERYINFO,
RAWTYPE_PLAIN_SIGNED_DELIVERYINFO,
RAWTYPE_CMS_SIGNED_DELIVERYINFO
} isds_raw_type;
/* Message */
struct isds_message {
void *raw; /* Raw message in XML format as send to or
from the ISDS. You can use it to store
local copy. This is binary buffer. */
size_t raw_length; /* Length of raw message in bytes */
isds_raw_type raw_type; /* Content type of raw representation
Meaningful only with non-NULL raw
member */
xmlDocPtr xml; /* Parsed XML document with attached ISDS
message XML documents.
Can be NULL. May be freed AFTER deallocating
documents member structure. */
struct isds_envelope *envelope; /* Message envelope */
struct isds_list *documents; /* List of isds_document's.
Valid message must contain exactly one
document of type FILEMETATYPE_MAIN and
can contain any number of other type
documents. Total size of documents
must not exceed 10 MB. */
};
/* Message copy recipient and assigned message ID */
struct isds_message_copy {
/* Input members defined by application */
char *dbIDRecipient; /* Box ID of recipient; Mandatory.
Maximal length is 7 characters. */
char *dmRecipientOrgUnit; /* Organisation unit of recipient as
string; Optional. */
long int *dmRecipientOrgUnitNum; /* Organisation unit of recipient as
number; Optional. */
char *dmToHands; /* Person in recipient organisation;
Optional. */
/* Output members returned from ISDS */
isds_error error; /* libisds compatible error of delivery to o ne recipient */
char *dmStatus; /* Error description returned by ISDS;
Optional. */
char *dmID; /* Assigned message ID; Meaningful only
for error == IE_SUCCESS */
};
/* Message state change event */
struct isds_message_status_change {
char *dmID; /* Message ID. */
isds_message_status *dmMessageStatus; /* Message state */
struct timeval *time; /* When the state changed */
};
/* How outgoing commercial message gets paid */
typedef enum {
PAYMENT_SENDER, /* Payed by a sender */
PAYMENT_STAMP, /* Pre-paid by a sender */
PAYMENT_SPONSOR, /* A sponsor pays all messages */
PAYMENT_RESPONSE, /* Recipient pays a response */
PAYMENT_SPONSOR_LIMITED, /* Undocumented */
PAYMENT_SPONSOR_EXTERNAL /* Undocomented */
} isds_payment_type;
/* Permission to send commercial message */
struct isds_commercial_permission {
isds_payment_type type; /* Payment method */
char *recipient; /* Send to this box ID only;
NULL means to anybody. */
char *payer; /* Owner of this box ID pays */
struct timeval *expiration; /* This permissions is valid until;
NULL means indefinitivly. */
unsigned long int *count; /* Number of messages that can be sent
on this permission;
NULL means unlimited. */
char *reply_identifier; /* Identifier to pair request and response
message. Meaningful only with type
PAYMENT_RESPONSE. */
};
/* Type of credit change event */
typedef enum {
ISDS_CREDIT_CHARGED, /* Credit has been charged */
ISDS_CREDIT_DISCHARGED, /* Credit has been discharged */
ISDS_CREDIT_MESSAGE_SENT, /* Credit has been spent for sending
a commerical message */
ISDS_CREDIT_STORAGE_SET, /* Credit has been spent for setting
a long-term storage */
ISDS_CREDIT_EXPIRED /* Credit has expired */
} isds_credit_event_type;
/* Data specific for ISDS_CREDIT_CHARGED isds_credit_event_type */
struct isds_credit_event_charged {
char *transaction; /* Transaction identifier;
NULL-terminated string. */
};
/* Data specific for ISDS_CREDIT_DISCHARGED isds_credit_event_type */
struct isds_credit_event_discharged {
char *transaction; /* Transaction identifier;
NULL-terminated string. */
};
/* Data specific for ISDS_CREDIT_MESSAGE_SENT isds_credit_event_type */
struct isds_credit_event_message_sent {
char *recipient; /* Recipent's box ID of the sent message */
char *message_id; /* ID of the sent message */
};
/* Data specific for ISDS_CREDIT_STORAGE_SET isds_credit_event_type */
struct isds_credit_event_storage_set {
long int new_capacity; /* New storage capacity. The unit is
a message. */
struct tm *new_valid_from; /* The new capacity is available since
date. */
struct tm *new_valid_to; /* The new capacity expires on date. */
long int *old_capacity; /* Previous storage capacity; Optional.
The unit is a message. */
struct tm *old_valid_from; /* Date; Optional; Only tm_year,
tm_mon, and tm_mday carry sane value. */
struct tm *old_valid_to; /* Date; Optional. */
char *initiator; /* Name of a user who initiated this
change; Optional. */
};
/* Event about change of credit for sending commerical services */
struct isds_credit_event {
/* Common fields */
struct timeval *time; /* When the credit was changed. */
long int credit_change; /* Difference in credit value caused by
this event. The unit is 1/100 CZK. */
long int new_credit; /* Credit value after this event.
The unit is 1/100 CZK. */
isds_credit_event_type type; /* Type of the event */
/* Datails specific for the type */
union {
struct isds_credit_event_charged charged;
/* ISDS_CREDIT_CHARGED */
struct isds_credit_event_discharged discharged;
/* ISDS_CREDIT_DISCHAGED */
struct isds_credit_event_message_sent message_sent;
/* ISDS_CREDIT_MESSAGE_SENT */
struct isds_credit_event_storage_set storage_set;
/* ISDS_CREDIT_STORAGE_SET */
} details;
};
/* General linked list */
struct isds_list {
struct isds_list *next; /* Next list item,
or NULL if current is last */
void *data; /* Payload */
void (*destructor) (void **); /* Payload deallocator;
Use NULL to have static data member. */
};
/* External box approval */
struct isds_approval {
_Bool approved; /* True if request for box has been
approved out of ISDS */
char *refference; /* Identifier of the approval */
};
/* Message sender type.
* Similar but not equivalent to isds_UserType. */
typedef enum {
SENDERTYPE_PRIMARY, /* Owner of the box */
SENDERTYPE_ENTRUSTED, /* User with limited access to the box */
SENDERTYPE_ADMINISTRATOR, /* User to manage ENTRUSTED_USERs */
SENDERTYPE_OFFICIAL, /* ISDS; sender of system message */
SENDERTYPE_VIRTUAL, /* An application (e.g. document
information system) */
SENDERTYPE_OFFICIAL_CERT, /* ???; Non-normative */
SENDERTYPE_LIQUIDATOR /* Liquidator of the company; Non-normative */
} isds_sender_type;
/* Digital delivery of credentials */
struct isds_credentials_delivery {
/* Input members */
char *email; /* e-mail address where to send
notification with link to service where
user can get know his new credentials */
/* Output members */
char *token; /* token user needs to use to authorize on
the web server to view his new
credentials. */
char *new_user_name; /* user's log-in name that ISDS created/
changed up on a call. */
};
/* Box attribute to search while performing full-text search */
typedef enum {
FULLTEXT_ALL, /* search in address, organization identifier, and
box id */
FULLTEXT_ADDRESS, /* search in address */
FULLTEXT_IC, /* search in organization identifier */
FULLTEXT_BOX_ID /* search in box ID */
} isds_fulltext_target;
/* A box matching full-text search */
struct isds_fulltext_result {
char *dbID; /* Box ID */
isds_DbType dbType; /* Box Type */
char *name; /* Subject owning the box */
struct isds_list *name_match_start; /* List of pointers into `name'
field string. Point to first
characters of a matched query
word. */
struct isds_list *name_match_end; /* List of pointers into `name'
field string. Point after last
characters of a matched query
word. */
char *address; /* Post address */
struct isds_list *address_match_start; /* List of pointers into `address'
field string. Point to first
characters of a matched query
word. */
struct isds_list *address_match_end; /* List of pointers into `address'
field string. Point after last
characters of a matched query
word. */
char *ic; /* Organization identifier */
struct tm *biDate; /* Date of birth in local time at birth place,
only tm_year, tm_mon and tm_mday carry sane
value */
_Bool dbEffectiveOVM; /* Box has OVM role (§ 5a) */
_Bool active; /* Box is active */
_Bool public_sending; /* Current box can send non-commercial
messages into this box */
_Bool commercial_sending; /* Current box can send commercial messages
into this box */
};
/* Initialize ISDS library.
* Global function, must be called before other functions.
* If it fails you can not use ISDS library and must call isds_cleanup() to
* free partially initialized global variables. */
isds_error isds_init(void);
/* Deinitialize ISDS library.
* Global function, must be called as last library function. */
isds_error isds_cleanup(void);
/* Return version string of this library. Version of dependencies can be
* embedded. Do no try to parse it. You must free it. */
char *isds_version(void);
/* Create ISDS context.
* Each context can be used for different sessions to (possibly) different
* ISDS server with different credentials.
* Returns new context, or NULL */
struct isds_ctx *isds_ctx_create(void);
/* Destroy ISDS context and free memory.
* @context will be NULLed on success. */
isds_error isds_ctx_free(struct isds_ctx **context);
/* Return long message text produced by library function, e.g. detailed error
* message. Returned pointer is only valid until new library function is
* called for the same context. Could be NULL, especially if NULL context is
* supplied. Return string is locale encoded. */
char *isds_long_message(const struct isds_ctx *context);
/* Set logging up.
* @facilities is bit mask of isds_log_facility values,
* @level is verbosity level. */
void isds_set_logging(const unsigned int facilities,
const isds_log_level level);
/* Function provided by application libisds will call to pass log message.
* The message is usually locale encoded, but raw strings (UTF-8 usually) can
* occur when logging raw communication with ISDS servers. Infixed zero byte
* is not excluded, but should not present. Use @length argument to get real
* length of the message.
* TODO: We will try to fix the encoding issue
* @facility is log message class
* @level is log message severity
* @message is string with zero byte terminator. This can be any arbitrary
* chunk of a sentence with or without new line, a sentence can be splitted
* into more messages. However it should not happen. If you discover message
* without new line, report it as a bug.
* @length is size of @message string in bytes excluding trailing zero
* @data is pointer that will be passed unchanged to this function at run-time
* */
typedef void (*isds_log_callback)(
isds_log_facility facility, isds_log_level level,
const char *message, int length, void *data);
/* Register callback function libisds calls when new global log message is
* produced by library. Library logs to stderr by default.
* @callback is function provided by application libisds will call. See type
* definition for @callback argument explanation. Pass NULL to revert logging to
* default behaviour.
* @data is application specific data @callback gets as last argument */
void isds_set_log_callback(isds_log_callback callback, void *data);
/* Set timeout in milliseconds for each network job like connecting to server
* or sending message. Use 0 to disable timeout limits. */
isds_error isds_set_timeout(struct isds_ctx *context,
const unsigned int timeout);
/* Function provided by application libisds will call with
* following five arguments. Value zero of any argument means the value is
* unknown.
* @upload_total is expected total upload,
* @upload_current is cumulative current upload progress
* @dowload_total is expected total download
* @download_current is cumulative current download progress
* @data is pointer that will be passed unchanged to this function at run-time
* @return 0 to continue HTTP transfer, or non-zero to abort transfer */
typedef int (*isds_progress_callback)(
double upload_total, double upload_current,
double download_total, double download_current,
void *data);
/* Register callback function libisds calls periodically during HTTP data
* transfer.
* @context is session context
* @callback is function provided by application libisds will call. See type
* definition for @callback argument explanation.
* @data is application specific data @callback gets as last argument */
isds_error isds_set_progress_callback(struct isds_ctx *context,
isds_progress_callback callback, void *data);
/* Change context settings.
* @context is context which setting will be applied to
* @option is name of option. It determines the type of last argument. See
* isds_option definition for more info.
* @... is value of new setting. Type is determined by @option
* */
isds_error isds_set_opt(struct isds_ctx *context, const isds_option option,
...);
/* Connect and log into ISDS server.
* All required arguments will be copied, you do not have to keep them after
* that.
* ISDS supports six different authentication methods. Exact method is
* selected on @username, @password, @pki_credentials, and @otp arguments:
* - If @pki_credentials == NULL, @username and @password must be supplied
* and then
* - If @otp == NULL, simple authentication by username and password will
* be proceeded.
* - If @otp != NULL, authentication by username and password and OTP
* will be used.
* - If @pki_credentials != NULL, then
* - If @username == NULL, only certificate will be used
* - If @username != NULL, then
* - If @password == NULL, then certificate will be used and
* @username shifts meaning to box ID. This is used for hosted
* services.
* - Otherwise all three arguments will be used.
* Please note, that different cases require different certificate type
* (system qualified one or commercial non qualified one). This library
* does not check such political issues. Please see ISDS Specification
* for more details.
* @url is base address of ISDS web service. Pass extern isds_locator
* variable to use production ISDS instance without client certificate
* authentication (or extern isds_cert_locator with client certificate
* authentication or extern isds_otp_locators with OTP authentication).
* Passing NULL has the same effect, autoselection between isds_locator,
* isds_cert_locator, and isds_otp_locator is performed in addition. You can
* pass extern isds_testing_locator (or isds_cert_testing_locator or
* isds_otp_testing_locator) variable to select testing instance.
* @username is user name of ISDS user or box ID
* @password is user's secret password
* @pki_credentials defines public key cryptographic material to use in client
* authentication.
* @otp selects one-time password authentication method to use, defines OTP
* code (if known) and returns fine grade resolution of OTP procedure.
* @return:
* IE_SUCCESS if authentication succeeds
* IE_NOT_LOGGED_IN if authentication fails. If OTP authentication has been
* requested, fine grade reason will be set into @otp->resolution. Error
* message from server can be obtained by isds_long_message() call.
* IE_PARTIAL_SUCCESS if time-based OTP authentication has been requested and
* server has sent OTP code through side channel. Application is expected to
* fill the code into @otp->otp_code, keep other arguments unchanged, and retry
* this call to complete second phase of TOTP authentication;
* or other appropriate error. */
isds_error isds_login(struct isds_ctx *context, const char *url,
const char *username, const char *password,
const struct isds_pki_credentials *pki_credentials,
struct isds_otp *otp);
/* Log out from ISDS server and close connection. */
isds_error isds_logout(struct isds_ctx *context);
/* Verify connection to ISDS is alive and server is responding.
* Send dummy request to ISDS and expect dummy response. */
isds_error isds_ping(struct isds_ctx *context);
/* Get data about logged in user and his box. */
isds_error isds_GetOwnerInfoFromLogin(struct isds_ctx *context,
struct isds_DbOwnerInfo **db_owner_info);
/* Get data about logged in user. */
isds_error isds_GetUserInfoFromLogin(struct isds_ctx *context,
struct isds_DbUserInfo **db_user_info);
/* Get expiration time of current password
* @context is session context
* @expiration is automatically reallocated time when password expires. If
* password expiration is disabled, NULL will be returned. In case of error
* it will be nulled too. */
isds_error isds_get_password_expiration(struct isds_ctx *context,
struct timeval **expiration);
/* Change user password in ISDS.
* User must supply old password, new password will takes effect after some
* time, current session can continue. Password must fulfill some constraints.
* @context is session context
* @old_password is current password.
* @new_password is requested new password
* @otp auxiliary data required if one-time password authentication is in use,
* defines OTP code (if known) and returns fine grade resolution of OTP
* procedure. Pass NULL, if one-time password authentication is not needed.
* Please note the @otp argument must match OTP method used at log-in time. See
* isds_login() function for more details.
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.
* @return IE_SUCCESS, if password has been changed. Or returns appropriate
* error code. It can return IE_PARTIAL_SUCCESS if OTP is in use and server is
* awaiting OTP code that has been delivered by side channel to the user. */
isds_error isds_change_password(struct isds_ctx *context,
const char *old_password, const char *new_password,
struct isds_otp *otp, char **refnumber);
/* Create new box.
* @context is session context
* @box is box description to create including single primary user (in case of
* FO box type). It outputs box ID assigned by ISDS in dbID element.
* @users is list of struct isds_DbUserInfo (primary users in case of non-FO
* box, or contact address of PFO box owner)
* @former_names is optional former name of box owner. Pass NULL if you don't care.
* @upper_box_id is optional ID of supper box if currently created box is
* subordinated.
* @ceo_label is optional title of OVM box owner (e.g. mayor)
* @credentials_delivery is NULL if new password should be delivered off-line
* to box owner. It is valid pointer if owner should obtain new password on-line
* on dedicated web server. Then input @credentials_delivery.email value is
* his e-mail address he must provide to dedicated web server together
* with output reallocated @credentials_delivery.token member. Output
* member @credentials_delivery.new_user_name is unused up on this call.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_add_box(struct isds_ctx *context,
struct isds_DbOwnerInfo *box, const struct isds_list *users,
const char *former_names, const char *upper_box_id,
const char *ceo_label,
struct isds_credentials_delivery *credentials_delivery,
const struct isds_approval *approval, char **refnumber);
/* Notify ISDS about new PFO entity.
* This function has no real effect.
* @context is session context
* @box is PFO description including single primary user.
* @users is list of struct isds_DbUserInfo (contact address of PFO box owner)
* @former_names is optional undocumented string. Pass NULL if you don't care.
* @upper_box_id is optional ID of supper box if currently created box is
* subordinated.
* @ceo_label is optional title of OVM box owner (e.g. mayor)
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_add_pfoinfo(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box, const struct isds_list *users,
const char *former_names, const char *upper_box_id,
const char *ceo_label, const struct isds_approval *approval,
char **refnumber);
/* Remove given box permanently.
* @context is session context
* @box is box description to delete
* @since is date of box owner cancellation. Only tm_year, tm_mon and tm_mday
* carry sane value.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_delete_box(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box, const struct tm *since,
const struct isds_approval *approval, char **refnumber);
/* Undocumented function.
* @context is session context
* @box is box description to delete
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_delete_box_promptly(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box,
const struct isds_approval *approval, char **refnumber);
/* Update data about given box.
* @context is session context
* @old_box current box description
* @new_box are updated data about @old_box
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_UpdateDataBoxDescr(struct isds_ctx *context,
const struct isds_DbOwnerInfo *old_box,
const struct isds_DbOwnerInfo *new_box,
const struct isds_approval *approval, char **refnumber);
/* Get data about all users assigned to given box.
* @context is session context
* @box_id is box ID
* @users is automatically reallocated list of struct isds_DbUserInfo */
isds_error isds_GetDataBoxUsers(struct isds_ctx *context, const char *box_id,
struct isds_list **users);
/* Update data about user assigned to given box.
* @context is session context
* @box is box identification
* @old_user identifies user to update
* @new_user are updated data about @old_user
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_UpdateDataBoxUser(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box,
const struct isds_DbUserInfo *old_user,
const struct isds_DbUserInfo *new_user,
char **refnumber);
/* Undocumented function.
* @context is session context
* @box_id is UTF-8 encoded box identifier
* @token is UTF-8 encoded temporary password
* @user_id outputs UTF-8 encoded reallocated user identifier
* @password outpus UTF-8 encoded reallocated user password
* Output arguments will be nulled in case of error */
isds_error isds_activate(struct isds_ctx *context,
const char *box_id, const char *token,
char **user_id, char **password);
/* Reset credentials of user assigned to given box.
* @context is session context
* @box is box identification
* @user identifies user to reset password
* @fee_paid is true if fee has been paid, false otherwise
* @approval is optional external approval of box manipulation
* @credentials_delivery is NULL if new password should be delivered off-line
* to the user. It is valid pointer if user should obtain new password on-line
* on dedicated web server. Then input @credentials_delivery.email value is
* user's e-mail address user must provide to dedicated web server together
* with @credentials_delivery.token. The output reallocated token user needs
* to use to authorize on the web server to view his new password. Output
* reallocated @credentials_delivery.new_user_name is user's log-in name that
* ISDS changed up on this call. (No reason why server could change the name
* is known now.)
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_reset_password(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box,
const struct isds_DbUserInfo *user,
const _Bool fee_paid, const struct isds_approval *approval,
struct isds_credentials_delivery *credentials_delivery,
char **refnumber);
/* Assign new user to given box.
* @context is session context
* @box is box identification
* @user defines new user to add
* @credentials_delivery is NULL if new user's password should be delivered
* off-line to the user. It is valid pointer if user should obtain new
* password on-line on dedicated web server. Then input
* @credentials_delivery.email value is user's e-mail address user must
* provide to dedicated web server together with @credentials_delivery.token.
* The output reallocated token user needs to use to authorize on the web
* server to view his new password. Output reallocated
* @credentials_delivery.new_user_name is user's log-in name that ISDS
* assingned up on this call.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_add_user(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box, const struct isds_DbUserInfo *user,
struct isds_credentials_delivery *credentials_delivery,
const struct isds_approval *approval, char **refnumber);
/* Remove user assigned to given box.
* @context is session context
* @box is box identification
* @user identifies user to remove
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_delete_user(struct isds_ctx *context,
const struct isds_DbOwnerInfo *box, const struct isds_DbUserInfo *user,
const struct isds_approval *approval, char **refnumber);
/* Get list of boxes in ZIP archive.
* @context is session context
* @list_identifier is UTF-8 encoded string identifying boxes of interrest.
* System recognizes following values currently: ALL (all boxes), UPG
* (effectively OVM boxes), OVM (OVM gross type boxes), OPN (boxes allowing
* receiving commercial messages). This argument is a string because
* specification states new values can appear in the future. Not all list
* types are available to all users.
* @buffer is automatically reallocated memory to store the list of boxes. The
* list is zipped CSV file.
* @buffer_length is size of @buffer data in bytes.
* In case of error @buffer will be freed and @buffer_length will be
* undefined.*/
isds_error isds_get_box_list_archive(struct isds_ctx *context,
const char *list_identifier, void **buffer, size_t *buffer_length);
/* Find boxes suiting given criteria.
* @context is ISDS session context.
* @criteria is filter. You should fill in at least some members.
* @boxes is automatically reallocated list of isds_DbOwnerInfo structures,
* possibly empty. Input NULL or valid old structure.
* @return:
* IE_SUCCESS if search succeeded, @boxes contains useful data
* IE_NOEXIST if no such box exists, @boxes will be NULL
* IE_2BIG if too much boxes exist and server truncated the results, @boxes
* contains still valid data
* other code if something bad happens. @boxes will be NULL. */
isds_error isds_FindDataBox(struct isds_ctx *context,
const struct isds_DbOwnerInfo *criteria,
struct isds_list **boxes);
/* Find boxes matching a given full-text criteria.
* @context is a session context
* @query is a non-empty string which consists of words to search
* @target selects box attributes to search for @query words. Pass NULL if you
* don't care.
* @box_type restricts searching to given box type. Value DBTYPE_SYSTEM means
* to search in all box types. Pass NULL to let server to use default value
* which is DBTYPE_SYSTEM.
* @page_size defines count of boxes to constitute a response page. It counts
* from zero. Pass NULL to let server to use a default value (50 now).
* @page_number defines ordinar number of the response page to return. It
* counts from zero. Pass NULL to let server to use a default value (0 now).
* @track_matches points to true for marking @query words found in the box
* attributes. It points to false for not marking. Pass NULL to let the server
* to use default value (false now).
* @total_matching_boxes outputs reallocated number of all boxes matching the
* query. Will be pointer to NULL if server did not provide the value.
* Pass NULL if you don't care.
* @current_page_beginning outputs reallocated ordinar number of the first box
* in this @boxes page. It counts from zero. It will be pointer to NULL if the
* server did not provide the value. Pass NULL if you don't care.
* @current_page_size outputs reallocated count of boxes in the this @boxes
* page. It will be pointer to NULL if the server did not provide the value.
* Pass NULL if you don't care.
* @last_page outputs pointer to reallocated boolean. True if this @boxes page
* is the last one, false if more boxes match, NULL if the server did not
* provude the value. Pass NULL if you don't care.
* @boxes outputs reallocated list of isds_fulltext_result structures,
* possibly empty.
* @return:
* IE_SUCCESS if search succeeded
* IE_2BIG if @page_size is too large
* other code if something bad happens; output arguments will be NULL. */
isds_error isds_find_box_by_fulltext(struct isds_ctx *context,
const char *query,
const isds_fulltext_target *target,
const isds_DbType *box_type,
const unsigned long int *page_size,
const unsigned long int *page_number,
const _Bool *track_matches,
unsigned long int **total_matching_boxes,
unsigned long int **current_page_beginning,
unsigned long int **current_page_size,
_Bool **last_page,
struct isds_list **boxes);
/* Get status of a box.
* @context is ISDS session context.
* @box_id is UTF-8 encoded box identifier as zero terminated string
* @box_status is return value of box status.
* @return:
* IE_SUCCESS if box has been found and its status retrieved
* IE_NOEXIST if box is not known to ISDS server
* or other appropriate error.
* You can use isds_DbState to enumerate box status. However out of enum
* range value can be returned too. This is feature because ISDS
* specification leaves the set of values open.
* Be ware that status DBSTATE_REMOVED is signaled as IE_SUCCESS. That means
* the box has been deleted, but ISDS still lists its former existence. */
isds_error isds_CheckDataBox(struct isds_ctx *context, const char *box_id,
long int *box_status);
/* Get list of permissions to send commercial messages.
* @context is ISDS session context.
* @box_id is UTF-8 encoded sender box identifier as zero terminated string
* @permissions is a reallocated list of permissions (struct
* isds_commercial_permission*) to send commercial messages from @box_id. The
* order of permissions is significant as the server applies the permissions
* and associated pre-paid credits in the order. Empty list means no
* permission.
* @return:
* IE_SUCCESS if the list has been obtained correctly,
* or other appropriate error. */
isds_error isds_get_commercial_permissions(struct isds_ctx *context,
const char *box_id, struct isds_list **permissions);
/* Get details about credit for sending pre-paid commercial messages.
* @context is ISDS session context.
* @box_id is UTF-8 encoded sender box identifier as zero terminated string.
* @from_date is first day of credit history to return in @history. Only
* tm_year, tm_mon and tm_mday carry sane value.
* @to_date is last day of credit history to return in @history. Only
* tm_year, tm_mon and tm_mday carry sane value.
* @credit outputs current credit value into pre-allocated memory. Pass NULL
* if you don't care. This and all other credit values are integers in
* hundredths of Czech Crowns.
* @email outputs notification e-mail address where notifications about credit
* are sent. This is automatically reallocated string. Pass NULL if you don't
* care. It can return NULL if no address is defined.
* @history outputs auto-reallocated list of pointers to struct
* isds_credit_event. Events in closed interval @from_time to @to_time are
* returned. Pass NULL @to_time and @from_time if you don't care. The events
* are sorted by time.
* @return:
* IE_SUCCESS if the credit details have been obtained correctly,
* or other appropriate error. Please note that server allows to retrieve
* only limited history of events. */
isds_error isds_get_commercial_credit(struct isds_ctx *context,
const char *box_id,
const struct tm *from_date, const struct tm *to_date,
long int *credit, char **email, struct isds_list **history);
/* Switch box into state where box can receive commercial messages (off by
* default)
* @context is ISDS session context.
* @box_id is UTF-8 encoded box identifier as zero terminated string
* @allow is true for enable, false for disable commercial messages income
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care. */
isds_error isds_switch_commercial_receiving(struct isds_ctx *context,
const char *box_id, const _Bool allow,
const struct isds_approval *approval, char **refnumber);
/* Switch box into / out of state where non-OVM box can act as OVM (e.g. force
* message acceptance). This is just a box permission. Sender must apply
* such role by sending each message.
* @context is ISDS session context.
* @box_id is UTF-8 encoded box identifier as zero terminated string
* @allow is true for enable, false for disable OVM role permission
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care. */
isds_error isds_switch_effective_ovm(struct isds_ctx *context,
const char *box_id, const _Bool allow,
const struct isds_approval *approval, char **refnumber);
/* Switch box accessibility state on request of box owner.
* Despite the name, owner must do the request off-line. This function is
* designed for such off-line meeting points (e.g. Czech POINT).
* @context is ISDS session context.
* @box identifies box to switch accessibility state.
* @allow is true for making accessible, false to disallow access.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care. */
isds_error isds_switch_box_accessibility_on_owner_request(
struct isds_ctx *context, const struct isds_DbOwnerInfo *box,
const _Bool allow, const struct isds_approval *approval,
char **refnumber);
/* Disable box accessibility on law enforcement (e.g. by prison) since exact
* date.
* @context is ISDS session context.
* @box identifies box to switch accessibility state.
* @since is date since accessibility has been denied. This can be past too.
* Only tm_year, tm_mon and tm_mday carry sane value.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care. */
isds_error isds_disable_box_accessibility_externaly(
struct isds_ctx *context, const struct isds_DbOwnerInfo *box,
const struct tm *since, const struct isds_approval *approval,
char **refnumber);
/* Send a message via ISDS to a recipient
* @context is session context
* @outgoing_message is message to send; Some members are mandatory (like
* dbIDRecipient), some are optional and some are irrelevant (especially data
* about sender). Included pointer to isds_list documents must contain at
* least one document of FILEMETATYPE_MAIN. This is read-write structure, some
* members will be filled with valid data from ISDS. Exact list of write
* members is subject to change. Currently dmID is changed.
* @return ISDS_SUCCESS, or other error code if something goes wrong. */
isds_error isds_send_message(struct isds_ctx *context,
struct isds_message *outgoing_message);
/* Send a message via ISDS to a multiple recipients
* @context is session context
* @outgoing_message is message to send; Some members are mandatory,
* some are optional and some are irrelevant (especially data
* about sender). Data about recipient will be substituted by ISDS from
* @copies. Included pointer to isds_list documents must
* contain at least one document of FILEMETATYPE_MAIN.
* @copies is list of isds_message_copy structures addressing all desired
* recipients. This is read-write structure, some members will be filled with
* valid data from ISDS (message IDs, error codes, error descriptions).
* @return
* ISDS_SUCCESS if all messages have been sent
* ISDS_PARTIAL_SUCCESS if sending of some messages has failed (failed and
* succeeded messages can be identified by copies->data->error),
* or other error code if something other goes wrong. */
isds_error isds_send_message_to_multiple_recipients(struct isds_ctx *context,
const struct isds_message *outgoing_message,
struct isds_list *copies);
/* Get list of outgoing (already sent) messages.
* Any criterion argument can be NULL, if you don't care about it.
* @context is session context. Must not be NULL.
* @from_time is minimal time and date of message sending inclusive.
* @to_time is maximal time and date of message sending inclusive
* @dmSenderOrgUnitNum is the same as isds_envelope.dmSenderOrgUnitNum
* @status_filter is bit field of isds_message_status values. Use special
* value MESSAGESTATE_ANY to signal you don't care. (It's defined as union of
* all values, you can use bit-wise arithmetic if you want.)
* @offset is index of first message we are interested in. First message is 1.
* Set to 0 (or 1) if you don't care.
* @number is maximal length of list you want to get as input value, outputs
* number of messages matching these criteria. Can be NULL if you don't care
* (applies to output value either).
* @messages is automatically reallocated list of isds_message's. Be ware that
* it returns only brief overview (envelope and some other fields) about each
* message, not the complete message. FIXME: Specify exact fields.
* The list is sorted by delivery time in ascending order.
* Use NULL if you don't care about the meta data (useful if you want to know
* only the @number). If you provide &NULL, list will be allocated on heap,
* if you provide pointer to non-NULL, list will be freed automatically at
* first. Also in case of error the list will be NULLed.
* @return IE_SUCCESS or appropriate error code. */
isds_error isds_get_list_of_sent_messages(struct isds_ctx *context,
const struct timeval *from_time, const struct timeval *to_time,
const long int *dmSenderOrgUnitNum, const unsigned int status_filter,
const unsigned long int offset, unsigned long int *number,
struct isds_list **messages);
/* Get list of incoming (addressed to you) messages.
* Any criterion argument can be NULL, if you don't care about it.
* @context is session context. Must not be NULL.
* @from_time is minimal time and date of message sending inclusive.
* @to_time is maximal time and date of message sending inclusive
* @dmRecipientOrgUnitNum is the same as isds_envelope.dmRecipientOrgUnitNum
* @status_filter is bit field of isds_message_status values. Use special
* value MESSAGESTATE_ANY to signal you don't care. (It's defined as union of
* all values, you can use bit-wise arithmetic if you want.)
* @offset is index of first message we are interested in. First message is 1.
* Set to 0 (or 1) if you don't care.
* @number is maximal length of list you want to get as input value, outputs
* number of messages matching these criteria. Can be NULL if you don't care
* (applies to output value either).
* @messages is automatically reallocated list of isds_message's. Be ware that
* it returns only brief overview (envelope and some other fields) about each
* message, not the complete message. FIXME: Specify exact fields.
* Use NULL if you don't care about the meta data (useful if you want to know
* only the @number). If you provide &NULL, list will be allocated on heap,
* if you provide pointer to non-NULL, list will be freed automatically at
* first. Also in case of error the list will be NULLed.
* @return IE_SUCCESS or appropriate error code. */
isds_error isds_get_list_of_received_messages(struct isds_ctx *context,
const struct timeval *from_time, const struct timeval *to_time,
const long int *dmRecipientOrgUnitNum,
const unsigned int status_filter,
const unsigned long int offset, unsigned long int *number,
struct isds_list **messages);
/* Get list of sent message state changes.
* Any criterion argument can be NULL, if you don't care about it.
* @context is session context. Must not be NULL.
* @from_time is minimal time and date of status changes inclusive
* @to_time is maximal time and date of status changes inclusive
* @changed_states is automatically reallocated list of
* isds_message_status_change's. If you provide &NULL, list will be allocated
* on heap, if you provide pointer to non-NULL, list will be freed
* automatically at first. Also in case of error the list will be NULLed.
* XXX: The list item ordering is not specified.
* XXX: Server provides only `recent' changes.
* @return IE_SUCCESS or appropriate error code. */
isds_error isds_get_list_of_sent_message_state_changes(
struct isds_ctx *context,
const struct timeval *from_time, const struct timeval *to_time,
struct isds_list **changed_states);
/* Download incoming message envelope identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_received_messages())
* @message is automatically reallocated message retrieved from ISDS.
* It will miss documents per se. Use isds_get_received_message(), if you are
* interested in documents (content) too.
* Returned hash and timestamp require documents to be verifiable. */
isds_error isds_get_received_envelope(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Download signed delivery info-sheet of given message identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_{sent,received}_messages())
* @message is automatically reallocated message retrieved from ISDS.
* It will miss documents per se. Use isds_get_signed_received_message(),
* if you are interested in documents (content). OTOH, only this function
* can get list events message has gone through. */
isds_error isds_get_signed_delivery_info(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Load delivery info of any format from buffer.
* @context is session context
* @raw_type advertises format of @buffer content. Only delivery info types
* are accepted.
* @buffer is DER encoded PKCS#7 structure with signed delivery info. You can
* retrieve such data from message->raw after calling
* isds_get_signed_delivery_info().
* @length is length of buffer in bytes.
* @message is automatically reallocated message parsed from @buffer.
* @strategy selects how buffer will be attached into raw isds_message member.
* */
isds_error isds_load_delivery_info(struct isds_ctx *context,
const isds_raw_type raw_type,
const void *buffer, const size_t length,
struct isds_message **message, const isds_buffer_strategy strategy);
/* Download delivery info-sheet of given message identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_{sent,received}_messages())
* @message is automatically reallocated message retrieved from ISDS.
* It will miss documents per se. Use isds_get_received_message(), if you are
* interested in documents (content). OTOH, only this function can get list
* of events message has gone through. */
isds_error isds_get_delivery_info(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Download incoming message identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_received_messages())
* @message is automatically reallocated message retrieved from ISDS */
isds_error isds_get_received_message(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Load message of any type from buffer.
* @context is session context
* @raw_type defines content type of @buffer. Only message types are allowed.
* @buffer is message raw representation. Format (CMS, plain signed,
* message direction) is defined in @raw_type. You can retrieve such data
* from message->raw after calling isds_get_[signed]{received,sent}_message().
* @length is length of buffer in bytes.
* @message is automatically reallocated message parsed from @buffer.
* @strategy selects how buffer will be attached into raw isds_message member.
* */
isds_error isds_load_message(struct isds_ctx *context,
const isds_raw_type raw_type, const void *buffer, const size_t length,
struct isds_message **message, const isds_buffer_strategy strategy);
/* Determine type of raw message or delivery info according some heuristics.
* It does not validate the raw blob.
* @context is session context
* @raw_type returns content type of @buffer. Valid only if exit code of this
* function is IE_SUCCESS. The pointer must be valid. This is no automatically
* reallocated memory.
* @buffer is message raw representation.
* @length is length of buffer in bytes. */
isds_error isds_guess_raw_type(struct isds_ctx *context,
isds_raw_type *raw_type, const void *buffer, const size_t length);
/* Download signed incoming message identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_received_messages())
* @message is automatically reallocated message retrieved from ISDS. The raw
* member will be filled with PKCS#7 structure in DER format. */
isds_error isds_get_signed_received_message(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Download signed outgoing message identified by ID.
* @context is session context
* @message_id is message identifier (you can get them from
* isds_get_list_of_sent_messages())
* @message is automatically reallocated message retrieved from ISDS. The raw
* member will be filled with PKCS#7 structure in DER format. */
isds_error isds_get_signed_sent_message(struct isds_ctx *context,
const char *message_id, struct isds_message **message);
/* Get type and name of user who sent a message identified by ID.
* @context is session context
* @message_id is message identifier
* @sender_type is pointer to automatically allocated type of sender detected
* from @raw_sender_type string. If @raw_sender_type is unknown to this
* library or to the server, NULL will be returned. Pass NULL if you don't
* care about it.
* @raw_sender_type is automatically reallocated UTF-8 string describing
* sender type or NULL if not known to server. Pass NULL if you don't care.
* @sender_name is automatically reallocated UTF-8 name of user who sent the
* message, or NULL if not known to ISDS. Pass NULL if you don't care. */
isds_error isds_get_message_sender(struct isds_ctx *context,
const char *message_id, isds_sender_type **sender_type,
char **raw_sender_type, char **sender_name);
/* Retrieve hash of message identified by ID stored in ISDS.
* @context is session context
* @message_id is message identifier
* @hash is automatically reallocated message hash downloaded from ISDS.
* Message must exist in system and must not be deleted. */
isds_error isds_download_message_hash(struct isds_ctx *context,
const char *message_id, struct isds_hash **hash);
/* Compute hash of message from raw representation and store it into envelope.
* Original hash structure will be destroyed in envelope.
* @context is session context
* @message is message carrying raw XML message blob
* @algorithm is desired hash algorithm to use */
isds_error isds_compute_message_hash(struct isds_ctx *context,
struct isds_message *message, const isds_hash_algorithm algorithm);
/* Compare two hashes.
* @h1 is first hash
* @h2 is another hash
* @return
* IE_SUCCESS if hashes equal
* IE_NOTUNIQ if hashes are comparable, but they don't equal
* IE_ENUM if not comparable, but both structures defined
* IE_INVAL if some of the structures are undefined (NULL)
* IE_ERROR if internal error occurs */
isds_error isds_hash_cmp(const struct isds_hash *h1,
const struct isds_hash *h2);
/* Check message has gone through ISDS by comparing message hash stored in
* ISDS and locally computed hash. You must provide message with valid raw
* member (do not use isds_load_message(..., BUFFER_DONT_STORE)).
* This is convenient wrapper for isds_download_message_hash(),
* isds_compute_message_hash(), and isds_hash_cmp() sequence.
* @context is session context
* @message is message with valid raw and envelope member; envelope->hash
* member will be changed during function run. Use envelope on heap only.
* @return
* IE_SUCCESS if message originates in ISDS
* IE_NOTEQUAL if message is unknown to ISDS
* other code for other errors */
isds_error isds_verify_message_hash(struct isds_ctx *context,
struct isds_message *message);
/* Submit CMS signed message to ISDS to verify its originality. This is
* stronger form of isds_verify_message_hash() because ISDS does more checks
* than simple one (potentialy old weak) hash comparison.
* @context is session context
* @message is memory with raw CMS signed message bit stream
* @length is @message size in bytes
* @return
* IE_SUCCESS if message originates in ISDS
* IE_NOTEQUAL if message is unknown to ISDS
* other code for other errors */
isds_error isds_authenticate_message(struct isds_ctx *context,
const void *message, size_t length);
/* Submit CMS signed message or delivery info to ISDS to re-sign the content
* including adding new CMS time stamp. Only CMS blobs without time stamp can
* be re-signed.
* @context is session context
* @input_data is memory with raw CMS signed message or delivery info bit
* stream to re-sign
* @input_length is @input_data size in bytes
* @output_data is pointer to auto-allocated memory where to store re-signed
* input data blob. Caller must free it.
* @output_data is pointer where to store @output_data size in bytes
* @valid_to is pointer to auto-allocated date of time stamp expiration.
* Only tm_year, tm_mon and tm_mday will be set. Pass NULL, if you don't care.
* @return
* IE_SUCCESS if CMS blob has been re-signed successfully
* other code for other errors */
isds_error isds_resign_message(struct isds_ctx *context,
const void *input_data, size_t input_length,
void **output_data, size_t *output_length, struct tm **valid_to);
/* Erase message specified by @message_id from long term storage. Other
* message cannot be erased on user request.
* @context is session context
* @message_id is message identifier.
* @incoming is true for incoming message, false for outgoing message.
* @return
* IE_SUCCESS if message has ben removed
* IE_INVAL if message does not exist in long term storage or message
* belongs to different box
* TODO: IE_NOEPRM if user has no permission to erase a message */
isds_error isds_delete_message_from_storage(struct isds_ctx *context,
const char *message_id, _Bool incoming);
/* Mark message as read. This is a transactional commit function to acknowledge
* to ISDS the message has been downloaded and processed by client properly.
* @context is session context
* @message_id is message identifier. */
isds_error isds_mark_message_read(struct isds_ctx *context,
const char *message_id);
/* Mark message as received by recipient. This is applicable only to
* commercial message. Use envelope->dmType message member to distinguish
* commercial message from government message. Government message is
* received automatically (by law), commercial message on recipient request.
* @context is session context
* @message_id is message identifier. */
isds_error isds_mark_message_received(struct isds_ctx *context,
const char *message_id);
/* Send bogus request to ISDS.
* Just for test purposes */
isds_error isds_bogus_request(struct isds_ctx *context);
/* Send document for authorized conversion into Czech POINT system.
* This is public anonymous service, no log-in necessary. Special context is
* used to reuse keep-a-live HTTPS connection.
* @context is Czech POINT session context. DO NOT use context connected to
* ISDS server. Use new context or context used by this function previously.
* @document is document to convert. Only data, data_length, dmFileDescr and
* is_xml members are significant. Be ware that not all document formats can be
* converted (signed PDF 1.3 and higher only (2010-02 state)).
* @id is reallocated identifier assigned by Czech POINT system to
* your document on submit. Use is to tell it to Czech POINT officer.
* @date is reallocated document submit date (submitted documents
* expires after some period). Only tm_year, tm_mon and tm_mday carry sane
* value. */
isds_error czp_convert_document(struct isds_ctx *context,
const struct isds_document *document,
char **id, struct tm **date);
/* Close possibly opened connection to Czech POINT document deposit.
* @context is Czech POINT session context. */
isds_error czp_close_connection(struct isds_ctx *context);
/* Send request for new box creation in testing ISDS instance.
* It's not possible to request for a production box currently, as it
* communicates via e-mail.
* XXX: This function does not work either. Server complains about invalid
* e-mail address.
* XXX: Remove context->type hacks in isds.c and validator.c when removing
* this function
* @context is special session context for box creation request. DO NOT use
* standard context as it could reveal your password. Use fresh new context or
* context previously used by this function.
* @box is box description to create including single primary user (in case of
* FO box type). It outputs box ID assigned by ISDS in dbID element.
* @users is list of struct isds_DbUserInfo (primary users in case of non-FO
* box, or contact address of PFO box owner). The email member is mandatory as
* it will be used to deliver credentials.
* @former_names is optional undocumented string. Pass NULL if you don't care.
* @approval is optional external approval of box manipulation
* @refnumber is reallocated serial number of request assigned by ISDS. Use
* NULL, if you don't care.*/
isds_error isds_request_new_testing_box(struct isds_ctx *context,
struct isds_DbOwnerInfo *box, const struct isds_list *users,
const char *former_names, const struct isds_approval *approval,
char **refnumber);
/* Search for document by document ID in list of documents. IDs are compared
* as UTF-8 string.
* @documents is list of isds_documents
* @id is document identifier
* @return first matching document or NULL. */
const struct isds_document *isds_find_document_by_id(
const struct isds_list *documents, const char *id);
/* Normalize @mime_type to be proper MIME type.
* ISDS servers pass invalid MIME types (e.g. "pdf"). This function tries to
* guess regular MIME type (e.g. "application/pdf").
* @mime_type is UTF-8 encoded MIME type to fix
* @return original @mime_type if no better interpretation exists, or
* constant static UTF-8 encoded string with proper MIME type. */
const char *isds_normalize_mime_type(const char *mime_type);
/* Deallocate structure isds_pki_credentials and NULL it.
* Pass-phrase is discarded.
* @pki credentials to to free */
void isds_pki_credentials_free(struct isds_pki_credentials **pki);
/* Free isds_list with all member data.
* @list list to free, on return will be NULL */
void isds_list_free(struct isds_list **list);
/* Deallocate structure isds_hash and NULL it.
* @hash hash to to free */
void isds_hash_free(struct isds_hash **hash);
/* Deallocate structure isds_PersonName recursively and NULL it */
void isds_PersonName_free(struct isds_PersonName **person_name);
/* Deallocate structure isds_BirthInfo recursively and NULL it */
void isds_BirthInfo_free(struct isds_BirthInfo **birth_info);
/* Deallocate structure isds_Address recursively and NULL it */
void isds_Address_free(struct isds_Address **address);
/* Deallocate structure isds_DbOwnerInfo recursively and NULL it */
void isds_DbOwnerInfo_free(struct isds_DbOwnerInfo **db_owner_info);
/* Deallocate structure isds_DbUserInfo recursively and NULL it */
void isds_DbUserInfo_free(struct isds_DbUserInfo **db_user_info);
/* Deallocate struct isds_event recursively and NULL it */
void isds_event_free(struct isds_event **event);
/* Deallocate struct isds_envelope recursively and NULL it */
void isds_envelope_free(struct isds_envelope **envelope);
/* Deallocate struct isds_document recursively and NULL it */
void isds_document_free(struct isds_document **document);
/* Deallocate struct isds_message recursively and NULL it */
void isds_message_free(struct isds_message **message);
/* Deallocate struct isds_message_copy recursively and NULL it */
void isds_message_copy_free(struct isds_message_copy **copy);
/* Deallocate struct isds_message_status_change recursively and NULL it */
void isds_message_status_change_free(
struct isds_message_status_change **message_status_change);
/* Deallocate struct isds_approval recursively and NULL it */
void isds_approval_free(struct isds_approval **approval);
/* Deallocate struct isds_commercial_permission recursively and NULL it */
void isds_commercial_permission_free(
struct isds_commercial_permission **permission);
/* Deallocate struct isds_credit_event recursively and NULL it */
void isds_credit_event_free(struct isds_credit_event **event);
/* Deallocate struct isds_credentials_delivery recursively and NULL it.
* The email string is deallocated too. */
void isds_credentials_delivery_free(
struct isds_credentials_delivery **credentials_delivery);
/* Deallocate struct isds_fulltext_result recursively and NULL it */
void isds_fulltext_result_free(
struct isds_fulltext_result **result);
/* Copy structure isds_PersonName recursively */
struct isds_PersonName *isds_PersonName_duplicate(
const struct isds_PersonName *src);
/* Copy structure isds_Address recursively */
struct isds_Address *isds_Address_duplicate(
const struct isds_Address *src);
/* Copy structure isds_DbOwnerInfo recursively */
struct isds_DbOwnerInfo *isds_DbOwnerInfo_duplicate(
const struct isds_DbOwnerInfo *src);
/* Copy structure isds_DbUserInfo recursively */
struct isds_DbUserInfo *isds_DbUserInfo_duplicate(
const struct isds_DbUserInfo *src);
#ifdef __cplusplus /* For C++ linker sake */
}
#endif
#endif
|