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
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gsasl.h: GNU SASL Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GNU SASL Reference Manual">
<link rel="up" href="intro.html" title="GNU SASL Reference Manual">
<link rel="prev" href="gsasl-gsasl-version.h.html" title="gsasl-version.h">
<link rel="next" href="gsasl-gsasl-mech.h.html" title="gsasl-mech.h">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gsasl-gsasl.h.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="intro.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gsasl-gsasl-version.h.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gsasl-gsasl-mech.h.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gsasl-gsasl.h"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gsasl-gsasl.h.top_of_page"></a>gsasl.h</span></h2>
<p>gsasl.h — main library interfaces</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gsasl-gsasl.h.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="gsasl-gsasl.h.html#Gsasl-callback-function" title="Gsasl_callback_function ()">*Gsasl_callback_function</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()">gsasl_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-done" title="gsasl_done ()">gsasl_done</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-check-version" title="gsasl_check_version ()">gsasl_check_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback-set" title="gsasl_callback_set ()">gsasl_callback_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback" title="gsasl_callback ()">gsasl_callback</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback-hook-set" title="gsasl_callback_hook_set ()">gsasl_callback_hook_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback-hook-get" title="gsasl_callback_hook_get ()">gsasl_callback_hook_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-session-hook-set" title="gsasl_session_hook_set ()">gsasl_session_hook_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-session-hook-get" title="gsasl_session_hook_get ()">gsasl_session_hook_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-set" title="gsasl_property_set ()">gsasl_property_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-set-raw" title="gsasl_property_set_raw ()">gsasl_property_set_raw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-free" title="gsasl_property_free ()">gsasl_property_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-get" title="gsasl_property_get ()">gsasl_property_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-fast" title="gsasl_property_fast ()">gsasl_property_fast</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-client-mechlist" title="gsasl_client_mechlist ()">gsasl_client_mechlist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-client-support-p" title="gsasl_client_support_p ()">gsasl_client_support_p</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-client-suggest-mechanism" title="gsasl_client_suggest_mechanism ()">gsasl_client_suggest_mechanism</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-server-mechlist" title="gsasl_server_mechlist ()">gsasl_server_mechlist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-server-support-p" title="gsasl_server_support_p ()">gsasl_server_support_p</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-mechanism-name-p" title="gsasl_mechanism_name_p ()">gsasl_mechanism_name_p</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-client-start" title="gsasl_client_start ()">gsasl_client_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-server-start" title="gsasl_server_start ()">gsasl_server_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-step" title="gsasl_step ()">gsasl_step</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-step64" title="gsasl_step64 ()">gsasl_step64</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-finish" title="gsasl_finish ()">gsasl_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-encode" title="gsasl_encode ()">gsasl_encode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-decode" title="gsasl_decode ()">gsasl_decode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-mechanism-name" title="gsasl_mechanism_name ()">gsasl_mechanism_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-strerror" title="gsasl_strerror ()">gsasl_strerror</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-strerror-name" title="gsasl_strerror_name ()">gsasl_strerror_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-saslprep" title="gsasl_saslprep ()">gsasl_saslprep</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-nonce" title="gsasl_nonce ()">gsasl_nonce</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-random" title="gsasl_random ()">gsasl_random</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">size_t</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-hash-length" title="gsasl_hash_length ()">gsasl_hash_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-scram-secrets-from-salted-password" title="gsasl_scram_secrets_from_salted_password ()">gsasl_scram_secrets_from_salted_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-scram-secrets-from-password" title="gsasl_scram_secrets_from_password ()">gsasl_scram_secrets_from_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-simple-getpass" title="gsasl_simple_getpass ()">gsasl_simple_getpass</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-base64-to" title="gsasl_base64_to ()">gsasl_base64_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-base64-from" title="gsasl_base64_from ()">gsasl_base64_from</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-hex-to" title="gsasl_hex_to ()">gsasl_hex_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-hex-from" title="gsasl_hex_from ()">gsasl_hex_from</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gsasl-gsasl.h.html#gsasl-free" title="gsasl_free ()">gsasl_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gsasl-gsasl.h.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl">Gsasl</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session">Gsasl_session</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-rc" title="enum Gsasl_rc">Gsasl_rc</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property">Gsasl_property</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-mechname-limits" title="enum Gsasl_mechname_limits">Gsasl_mechname_limits</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-qop" title="enum Gsasl_qop">Gsasl_qop</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-saslprep-flags" title="enum Gsasl_saslprep_flags">Gsasl_saslprep_flags</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash">Gsasl_hash</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gsasl-gsasl.h.html#Gsasl-hash-length" title="enum Gsasl_hash_length">Gsasl_hash_length</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gsasl-gsasl.h.description"></a><h2>Description</h2>
<p>The main library interfaces are declared in gsasl.h.</p>
</div>
<div class="refsect1">
<a name="gsasl-gsasl.h.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="Gsasl-callback-function"></a><h3>Gsasl_callback_function ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
<span class="c_punctuation">(</span>*Gsasl_callback_function<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>);</pre>
<p>Prototype of function that the application should implement. Use
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback-set" title="gsasl_callback_set ()"><code class="function">gsasl_callback_set()</code></a> to inform the library about your callback
function.</p>
<p>It is called by the SASL library when it need some information
from the application. Depending on the value of <em class="parameter"><code>prop</code></em>
, it should
either set some property (e.g., username or password) using
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-set" title="gsasl_property_set ()"><code class="function">gsasl_property_set()</code></a>, or it should extract some properties (e.g.,
authentication and authorization identities) using
<a class="link" href="gsasl-gsasl.h.html#gsasl-property-fast" title="gsasl_property_fast ()"><code class="function">gsasl_property_fast()</code></a> and use them to make a policy decision,
perhaps returning GSASL_AUTHENTICATION_ERROR or GSASL_OK
depending on whether the policy permitted the operation.</p>
<div class="refsect3">
<a name="Gsasl-callback-function.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle, may be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="Gsasl-callback-function.returns"></a><h4>Returns</h4>
<p> Any valid return code, the interpretation of which
depend on the <em class="parameter"><code>prop</code></em>
value.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-init"></a><h3>gsasl_init ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_init (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> **ctx</code></em>);</pre>
<p>This functions initializes libgsasl. The handle pointed to by ctx
is valid for use with other libgsasl functions iff this function is
successful. It also register all builtin SASL mechanisms, using
<a class="link" href="gsasl-gsasl-mech.h.html#gsasl-register" title="gsasl_register ()"><code class="function">gsasl_register()</code></a>.</p>
<div class="refsect3">
<a name="gsasl-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>pointer to libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-init.returns"></a><h4>Returns</h4>
<p> GSASL_OK iff successful, otherwise
<a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-done"></a><h3>gsasl_done ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_done (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>);</pre>
<p>This function destroys a libgsasl handle. The handle must not be
used with other libgsasl functions after this call.</p>
<div class="refsect3">
<a name="gsasl-done.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-check-version"></a><h3>gsasl_check_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_check_version (<em class="parameter"><code>const <span class="type">char</span> *req_version</code></em>);</pre>
<p>Check GNU SASL Library version.</p>
<p>See <a class="link" href="gsasl-gsasl-version.h.html#GSASL-VERSION:CAPS" title="GSASL_VERSION"><code class="literal">GSASL_VERSION</code></a> for a suitable <em class="parameter"><code>req_version</code></em>
string.</p>
<p>This function is one of few in the library that can be used without
a successful call to <a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()"><code class="function">gsasl_init()</code></a>.</p>
<div class="refsect3">
<a name="gsasl-check-version.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>req_version</p></td>
<td class="parameter_description"><p>version string to compare with, or NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-check-version.returns"></a><h4>Returns</h4>
<p> Check that the version of the library is at
minimum the one given as a string in <em class="parameter"><code>req_version</code></em>
and return the
actual version string of the library; return NULL if the
condition is not met. If NULL is passed to this function no
check is done and only the version string is returned.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-callback-set"></a><h3>gsasl_callback_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_callback_set (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-callback-function" title="Gsasl_callback_function ()"><span class="type">Gsasl_callback_function</span></a> cb</code></em>);</pre>
<p>Store the pointer to the application provided callback in the
library handle. The callback will be used, via <a class="link" href="gsasl-gsasl.h.html#gsasl-callback" title="gsasl_callback ()"><code class="function">gsasl_callback()</code></a>,
by mechanisms to discover various parameters (such as username and
passwords). The callback function will be called with a
Gsasl_property value indicating the requested behaviour. For
example, for <a class="link" href="gsasl-gsasl.h.html#GSASL-ANONYMOUS-TOKEN:CAPS"><code class="literal">GSASL_ANONYMOUS_TOKEN</code></a>, the function is expected to
invoke gsasl_property_set(<em class="parameter"><code>CTX</code></em>
, <a class="link" href="gsasl-gsasl.h.html#GSASL-ANONYMOUS-TOKEN:CAPS"><code class="literal">GSASL_ANONYMOUS_TOKEN</code></a>, "token")
where "token" is the anonymous token the application wishes the
SASL mechanism to use. See the manual for the meaning of all
parameters.</p>
<div class="refsect3">
<a name="gsasl-callback-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>handle received from <a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()"><code class="function">gsasl_init()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cb</p></td>
<td class="parameter_description"><p>pointer to function implemented by application.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-callback"></a><h3>gsasl_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_callback (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>);</pre>
<p>Invoke the application callback. The <em class="parameter"><code>prop</code></em>
value indicate what the
callback is expected to do. For example, for
<a class="link" href="gsasl-gsasl.h.html#GSASL-ANONYMOUS-TOKEN:CAPS"><code class="literal">GSASL_ANONYMOUS_TOKEN</code></a>, the function is expected to invoke
gsasl_property_set(<em class="parameter"><code>SCTX</code></em>
, <a class="link" href="gsasl-gsasl.h.html#GSASL-ANONYMOUS-TOKEN:CAPS"><code class="literal">GSASL_ANONYMOUS_TOKEN</code></a>, "token") where
"token" is the anonymous token the application wishes the SASL
mechanism to use. See the manual for the meaning of all
parameters.</p>
<div class="refsect3">
<a name="gsasl-callback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>handle received from <a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()"><code class="function">gsasl_init()</code></a>, may be NULL to derive it
from <em class="parameter"><code>sctx</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-callback.returns"></a><h4>Returns</h4>
<p> Returns whatever the application callback returns, or
<a class="link" href="gsasl-gsasl.h.html#GSASL-NO-CALLBACK:CAPS"><code class="literal">GSASL_NO_CALLBACK</code></a> if no application was known.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-callback-hook-set"></a><h3>gsasl_callback_hook_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_callback_hook_set (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><span class="type">void</span> *hook</code></em>);</pre>
<p>Store application specific data in the libgsasl handle.</p>
<p>The application data can be later (for instance, inside a callback)
be retrieved by calling <a class="link" href="gsasl-gsasl.h.html#gsasl-callback-hook-get" title="gsasl_callback_hook_get ()"><code class="function">gsasl_callback_hook_get()</code></a>. This is
normally used by the application to maintain a global state between
the main program and callbacks.</p>
<div class="refsect3">
<a name="gsasl-callback-hook-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hook</p></td>
<td class="parameter_description"><p>opaque pointer to application specific data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-callback-hook-get"></a><h3>gsasl_callback_hook_get ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
gsasl_callback_hook_get (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>);</pre>
<p>Retrieve application specific data from libgsasl handle.</p>
<p>The application data is set using <a class="link" href="gsasl-gsasl.h.html#gsasl-callback-hook-set" title="gsasl_callback_hook_set ()"><code class="function">gsasl_callback_hook_set()</code></a>. This
is normally used by the application to maintain a global state
between the main program and callbacks.</p>
<div class="refsect3">
<a name="gsasl-callback-hook-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-callback-hook-get.returns"></a><h4>Returns</h4>
<p> Returns the application specific data, or NULL.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-session-hook-set"></a><h3>gsasl_session_hook_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_session_hook_set (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><span class="type">void</span> *hook</code></em>);</pre>
<p>Store application specific data in the libgsasl session handle.</p>
<p>The application data can be later (for instance, inside a callback)
be retrieved by calling <a class="link" href="gsasl-gsasl.h.html#gsasl-session-hook-get" title="gsasl_session_hook_get ()"><code class="function">gsasl_session_hook_get()</code></a>. This is normally
used by the application to maintain a per-session state between the
main program and callbacks.</p>
<div class="refsect3">
<a name="gsasl-session-hook-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hook</p></td>
<td class="parameter_description"><p>opaque pointer to application specific data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-14.html#api-index-0.2.14">0.2.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-session-hook-get"></a><h3>gsasl_session_hook_get ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
gsasl_session_hook_get (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>);</pre>
<p>Retrieve application specific data from libgsasl session handle.</p>
<p>The application data is set using <a class="link" href="gsasl-gsasl.h.html#gsasl-callback-hook-set" title="gsasl_callback_hook_set ()"><code class="function">gsasl_callback_hook_set()</code></a>. This
is normally used by the application to maintain a per-session state
between the main program and callbacks.</p>
<div class="refsect3">
<a name="gsasl-session-hook-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-session-hook-get.returns"></a><h4>Returns</h4>
<p> Returns the application specific data, or NULL.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-14.html#api-index-0.2.14">0.2.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-property-set"></a><h3>gsasl_property_set ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_property_set (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *data</code></em>);</pre>
<p>Make a copy of <em class="parameter"><code>data</code></em>
and store it in the session handle for the
indicated property <em class="parameter"><code>prop</code></em>
.</p>
<p>You can immediately deallocate <em class="parameter"><code>data</code></em>
after calling this function,
without affecting the data stored in the session handle.</p>
<div class="refsect3">
<a name="gsasl-property-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type, indicating the
type of data in <em class="parameter"><code>data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>zero terminated character string to store.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-property-set.returns"></a><h4>Returns</h4>
<p> <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> iff successful, otherwise
<a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-property-set-raw"></a><h3>gsasl_property_set_raw ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_property_set_raw (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
<p>Make a copy of <em class="parameter"><code>len</code></em>
sized <em class="parameter"><code>data</code></em>
and store a zero terminated version
of it in the session handle for the indicated property <em class="parameter"><code>prop</code></em>
.</p>
<p>You can immediately deallocate <em class="parameter"><code>data</code></em>
after calling this function,
without affecting the data stored in the session handle.</p>
<p>Except for the length indicator, this function is identical to
gsasl_property_set.</p>
<div class="refsect3">
<a name="gsasl-property-set-raw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type, indicating the
type of data in <em class="parameter"><code>data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>character string to store.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>length of character string to store.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-property-set-raw.returns"></a><h4>Returns</h4>
<p> <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> iff successful, otherwise
<a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-property-free"></a><h3>gsasl_property_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_property_free (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>);</pre>
<p>Deallocate associated data with property <em class="parameter"><code>prop</code></em>
in session handle.
After this call, gsasl_property_fast(<em class="parameter"><code>sctx</code></em>
, <em class="parameter"><code>prop</code></em>
) will always
return NULL.</p>
<div class="refsect3">
<a name="gsasl-property-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of <a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><code class="literal">Gsasl_property</code></a> type to clear</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-0-0.html#api-index-2.0.0">2.0.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-property-get"></a><h3>gsasl_property_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_property_get (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>);</pre>
<p>Retrieve the data stored in the session handle for given property
<em class="parameter"><code>prop</code></em>
, possibly invoking the application callback to get the value.</p>
<p>The pointer is to live data, and must not be deallocated or
modified in any way.</p>
<p>This function will invoke the application callback, using
<a class="link" href="gsasl-gsasl.h.html#gsasl-callback" title="gsasl_callback ()"><code class="function">gsasl_callback()</code></a>, when a property value is not known.</p>
<div class="refsect3">
<a name="gsasl-property-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type, indicating the
type of data in <em class="parameter"><code>data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-property-get.returns"></a><h4>Returns</h4>
<p> Return data for property, or NULL if no value known.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-property-fast"></a><h3>gsasl_property_fast ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_property_fast (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-property" title="enum Gsasl_property"><span class="type">Gsasl_property</span></a> prop</code></em>);</pre>
<p>Retrieve the data stored in the session handle for given property
<em class="parameter"><code>prop</code></em>
.</p>
<p>The pointer is to live data, and must not be deallocated or
modified in any way.</p>
<p>This function will not invoke the application callback.</p>
<div class="refsect3">
<a name="gsasl-property-fast.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>enumerated value of Gsasl_property type, indicating the
type of data in <em class="parameter"><code>data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-property-fast.returns"></a><h4>Returns</h4>
<p> Return property value, if known, or NULL if no value
known.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-0.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-client-mechlist"></a><h3>gsasl_client_mechlist ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_client_mechlist (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>);</pre>
<p>Return a newly allocated string containing SASL names, separated by
space, of mechanisms supported by the libgsasl client. <em class="parameter"><code>out</code></em>
is
allocated by this function, and it is the responsibility of caller
to deallocate it.</p>
<div class="refsect3">
<a name="gsasl-client-mechlist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>newly allocated output character array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-client-mechlist.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-client-support-p"></a><h3>gsasl_client_support_p ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_client_support_p (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>Decide whether there is client-side support for a specified
mechanism.</p>
<div class="refsect3">
<a name="gsasl-client-support-p.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of SASL mechanism.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-client-support-p.returns"></a><h4>Returns</h4>
<p> Returns 1 if the libgsasl client supports the named
mechanism, otherwise 0.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-client-suggest-mechanism"></a><h3>gsasl_client_suggest_mechanism ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_client_suggest_mechanism (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *mechlist</code></em>);</pre>
<p>Given a list of mechanisms, suggest which to use.</p>
<div class="refsect3">
<a name="gsasl-client-suggest-mechanism.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mechlist</p></td>
<td class="parameter_description"><p>input character array with SASL mechanism names,
separated by invalid characters (e.g. SPC).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-client-suggest-mechanism.returns"></a><h4>Returns</h4>
<p> Returns name of "best" SASL mechanism supported by
the libgsasl client which is present in the input string, or
NULL if no supported mechanism is found.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-server-mechlist"></a><h3>gsasl_server_mechlist ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_server_mechlist (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>);</pre>
<p>Return a newly allocated string containing SASL names, separated by
space, of mechanisms supported by the libgsasl server. <em class="parameter"><code>out</code></em>
is
allocated by this function, and it is the responsibility of caller
to deallocate it.</p>
<div class="refsect3">
<a name="gsasl-server-mechlist.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>newly allocated output character array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-server-mechlist.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-server-support-p"></a><h3>gsasl_server_support_p ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_server_support_p (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>Decide whether there is server-side support for a specified
mechanism.</p>
<div class="refsect3">
<a name="gsasl-server-support-p.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of SASL mechanism.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-server-support-p.returns"></a><h4>Returns</h4>
<p> Returns 1 if the libgsasl server supports the named
mechanism, otherwise 0.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-mechanism-name-p"></a><h3>gsasl_mechanism_name_p ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_mechanism_name_p (<em class="parameter"><code>const <span class="type">char</span> *mech</code></em>);</pre>
<p>Check if the mechanism name string <em class="parameter"><code>mech</code></em>
follows syntactical rules.
It does not check that the name is registered with IANA. It does not
check that the mechanism name is actually implemented and supported.</p>
<p>SASL mechanisms are named by strings, from 1 to 20 characters in
length, consisting of upper-case letters, digits, hyphens, and/or
underscores.</p>
<div class="refsect3">
<a name="gsasl-mechanism-name-p.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mech</p></td>
<td class="parameter_description"><p>input variable with mechanism name string.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-mechanism-name-p.returns"></a><h4>Returns</h4>
<p> non-zero when mechanism name string <em class="parameter"><code>mech</code></em>
conforms to
rules, zero when it does not meet the requirements.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-0-0.html#api-index-2.0.0">2.0.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-client-start"></a><h3>gsasl_client_start ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_client_start (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *mech</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> **sctx</code></em>);</pre>
<p>This functions initiates a client SASL authentication. This
function must be called before any other gsasl_client_*() function
is called.</p>
<div class="refsect3">
<a name="gsasl-client-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mech</p></td>
<td class="parameter_description"><p>name of SASL mechanism.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>pointer to client handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-client-start.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-server-start"></a><h3>gsasl_server_start ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_server_start (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl" title="Gsasl"><span class="type">Gsasl</span></a> *ctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *mech</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> **sctx</code></em>);</pre>
<p>This functions initiates a server SASL authentication. This
function must be called before any other gsasl_server_*() function
is called.</p>
<div class="refsect3">
<a name="gsasl-server-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p>libgsasl handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mech</p></td>
<td class="parameter_description"><p>name of SASL mechanism.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>pointer to server handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-server-start.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-step"></a><h3>gsasl_step ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_step (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *input</code></em>,
<em class="parameter"><code><span class="type">size_t</span> input_len</code></em>,
<em class="parameter"><code><span class="type">char</span> **output</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *output_len</code></em>);</pre>
<p>Perform one step of SASL authentication. This reads data from the
other end (from <em class="parameter"><code>input</code></em>
and <em class="parameter"><code>input_len</code></em>
), processes it (potentially
invoking callbacks to the application), and writes data to server
(into newly allocated variable <em class="parameter"><code>output</code></em>
and <em class="parameter"><code>output_len</code></em>
that
indicate the length of <em class="parameter"><code>output</code></em>
).</p>
<p>The contents of the <em class="parameter"><code>output</code></em>
buffer is unspecified if this functions
returns anything other than <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> or <a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a>. If
this function return <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> or <a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a>, however, the
<em class="parameter"><code>output</code></em>
buffer is allocated by this function, and it is the
responsibility of caller to deallocate it by calling
gsasl_free(<em class="parameter"><code>output</code></em>
).</p>
<div class="refsect3">
<a name="gsasl-step.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input</p></td>
<td class="parameter_description"><p>input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input_len</p></td>
<td class="parameter_description"><p>size of input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output</p></td>
<td class="parameter_description"><p>newly allocated output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output_len</p></td>
<td class="parameter_description"><p>pointer to output variable with size of output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-step.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if authenticated terminated
successfully, <a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a> if more data is needed, or error
code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-step64"></a><h3>gsasl_step64 ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_step64 (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *b64input</code></em>,
<em class="parameter"><code><span class="type">char</span> **b64output</code></em>);</pre>
<p>This is a simple wrapper around <a class="link" href="gsasl-gsasl.h.html#gsasl-step" title="gsasl_step ()"><code class="function">gsasl_step()</code></a> that base64 decodes
the input and base64 encodes the output.</p>
<p>The contents of the <em class="parameter"><code>b64output</code></em>
buffer is unspecified if this
functions returns anything other than <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> or
<a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a>. If this function return <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> or
<a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a>, however, the <em class="parameter"><code>b64output</code></em>
buffer is allocated by
this function, and it is the responsibility of caller to deallocate
it by calling gsasl_free(<em class="parameter"><code>b64output</code></em>
).</p>
<div class="refsect3">
<a name="gsasl-step64.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl client handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>b64input</p></td>
<td class="parameter_description"><p>input base64 encoded byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>b64output</p></td>
<td class="parameter_description"><p>newly allocated output base64 encoded byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-step64.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if authenticated terminated
successfully, <a class="link" href="gsasl-gsasl.h.html#GSASL-NEEDS-MORE:CAPS"><code class="literal">GSASL_NEEDS_MORE</code></a> if more data is needed, or error
code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-finish"></a><h3>gsasl_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_finish (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>);</pre>
<p>Destroy a libgsasl client or server handle. The handle must not be
used with other libgsasl functions after this call.</p>
<div class="refsect3">
<a name="gsasl-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-encode"></a><h3>gsasl_encode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_encode (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *input</code></em>,
<em class="parameter"><code><span class="type">size_t</span> input_len</code></em>,
<em class="parameter"><code><span class="type">char</span> **output</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *output_len</code></em>);</pre>
<p>Encode data according to negotiated SASL mechanism. This might mean
that data is integrity or privacy protected.</p>
<p>The <em class="parameter"><code>output</code></em>
buffer is allocated by this function, and it is the
responsibility of caller to deallocate it by calling
gsasl_free(<em class="parameter"><code>output</code></em>
).</p>
<div class="refsect3">
<a name="gsasl-encode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input</p></td>
<td class="parameter_description"><p>input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input_len</p></td>
<td class="parameter_description"><p>size of input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output</p></td>
<td class="parameter_description"><p>newly allocated output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output_len</p></td>
<td class="parameter_description"><p>pointer to output variable with size of output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-encode.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if encoding was successful,
otherwise an error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-decode"></a><h3>gsasl_decode ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_decode (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *input</code></em>,
<em class="parameter"><code><span class="type">size_t</span> input_len</code></em>,
<em class="parameter"><code><span class="type">char</span> **output</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *output_len</code></em>);</pre>
<p>Decode data according to negotiated SASL mechanism. This might mean
that data is integrity or privacy protected.</p>
<p>The <em class="parameter"><code>output</code></em>
buffer is allocated by this function, and it is the
responsibility of caller to deallocate it by calling
gsasl_free(<em class="parameter"><code>output</code></em>
).</p>
<div class="refsect3">
<a name="gsasl-decode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input</p></td>
<td class="parameter_description"><p>input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input_len</p></td>
<td class="parameter_description"><p>size of input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output</p></td>
<td class="parameter_description"><p>newly allocated output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>output_len</p></td>
<td class="parameter_description"><p>pointer to output variable with size of output byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-decode.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if encoding was successful,
otherwise an error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-mechanism-name"></a><h3>gsasl_mechanism_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_mechanism_name (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-session" title="Gsasl_session"><span class="type">Gsasl_session</span></a> *sctx</code></em>);</pre>
<p>This function returns the name of the SASL mechanism used in the
session. The pointer must not be deallocated by the caller.</p>
<div class="refsect3">
<a name="gsasl-mechanism-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sctx</p></td>
<td class="parameter_description"><p>libgsasl session handle.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-mechanism-name.returns"></a><h4>Returns</h4>
<p> Returns a zero terminated character array with the
name of the SASL mechanism, or NULL if not known.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-28.html#api-index-0.2.28">0.2.28</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-strerror"></a><h3>gsasl_strerror ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_strerror (<em class="parameter"><code><span class="type">int</span> err</code></em>);</pre>
<p>Convert return code to human readable string explanation of the
reason for the particular error code.</p>
<p>This string can be used to output a diagnostic message to the user.</p>
<p>This function is one of few in the library that can be used without
a successful call to <a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()"><code class="function">gsasl_init()</code></a>.</p>
<div class="refsect3">
<a name="gsasl-strerror.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>libgsasl error code</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-strerror.returns"></a><h4>Returns</h4>
<p> Returns a pointer to a statically allocated string
containing an explanation of the error code <em class="parameter"><code>err</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-strerror-name"></a><h3>gsasl_strerror_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gsasl_strerror_name (<em class="parameter"><code><span class="type">int</span> err</code></em>);</pre>
<p>Convert return code to human readable string representing the error
code symbol itself. For example, gsasl_strerror_name(<a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a>)
returns the string "GSASL_OK".</p>
<p>This string can be used to output a diagnostic message to the user.</p>
<p>This function is one of few in the library that can be used without
a successful call to <a class="link" href="gsasl-gsasl.h.html#gsasl-init" title="gsasl_init ()"><code class="function">gsasl_init()</code></a>.</p>
<div class="refsect3">
<a name="gsasl-strerror-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>libgsasl error code</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-strerror-name.returns"></a><h4>Returns</h4>
<p> Returns a pointer to a statically allocated string
containing a string version of the error code <em class="parameter"><code>err</code></em>
, or NULL if
the error code is not known.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-29.html#api-index-0.2.29">0.2.29</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-saslprep"></a><h3>gsasl_saslprep ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_saslprep (<em class="parameter"><code>const <span class="type">char</span> *in</code></em>,
<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-saslprep-flags" title="enum Gsasl_saslprep_flags"><span class="type">Gsasl_saslprep_flags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>,
<em class="parameter"><code><span class="type">int</span> *stringpreprc</code></em>);</pre>
<p>Prepare string using SASLprep. On success, the <em class="parameter"><code>out</code></em>
variable must
be deallocated by the caller.</p>
<div class="refsect3">
<a name="gsasl-saslprep.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>a UTF-8 encoded string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>any SASLprep flag, e.g., <a class="link" href="gsasl-gsasl.h.html#GSASL-ALLOW-UNASSIGNED:CAPS"><code class="literal">GSASL_ALLOW_UNASSIGNED</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>on exit, contains newly allocated output string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stringpreprc</p></td>
<td class="parameter_description"><p>if non-NULL, will hold precise stringprep return code.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-saslprep.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> on success, or
<a class="link" href="gsasl-gsasl.h.html#GSASL-SASLPREP-ERROR:CAPS"><code class="literal">GSASL_SASLPREP_ERROR</code></a> on error.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-3.html#api-index-0.2.3">0.2.3</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-nonce"></a><h3>gsasl_nonce ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_nonce (<em class="parameter"><code><span class="type">char</span> *data</code></em>,
<em class="parameter"><code><span class="type">size_t</span> datalen</code></em>);</pre>
<p>Store unpredictable data of given size in the provided buffer.</p>
<div class="refsect3">
<a name="gsasl-nonce.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>output array to be filled with unpredictable random data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>datalen</p></td>
<td class="parameter_description"><p>size of output array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-nonce.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> iff successful.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-random"></a><h3>gsasl_random ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_random (<em class="parameter"><code><span class="type">char</span> *data</code></em>,
<em class="parameter"><code><span class="type">size_t</span> datalen</code></em>);</pre>
<p>Store cryptographically strong random data of given size in the
provided buffer.</p>
<div class="refsect3">
<a name="gsasl-random.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>output array to be filled with strong random data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>datalen</p></td>
<td class="parameter_description"><p>size of output array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-random.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> iff successful.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-hash-length"></a><h3>gsasl_hash_length ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span>
gsasl_hash_length (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><span class="type">Gsasl_hash</span></a> hash</code></em>);</pre>
<p>Return the digest output size for hash function <em class="parameter"><code>hash</code></em>
. For
example, gsasl_hash_length(GSASL_HASH_SHA256) returns
GSASL_HASH_SHA256_SIZE which is 32.</p>
<div class="refsect3">
<a name="gsasl-hash-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>hash</p></td>
<td class="parameter_description"><p>a <a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><code class="literal">Gsasl_hash</code></a> element, e.g., <a class="link" href="gsasl-gsasl.h.html#GSASL-HASH-SHA256:CAPS"><span class="type">GSASL_HASH_SHA256</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-hash-length.returns"></a><h4>Returns</h4>
<p> size of supplied <a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><code class="literal">Gsasl_hash</code></a> element.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-scram-secrets-from-salted-password"></a><h3>gsasl_scram_secrets_from_salted_password ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_scram_secrets_from_salted_password
(<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><span class="type">Gsasl_hash</span></a> hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *salted_password</code></em>,
<em class="parameter"><code><span class="type">char</span> *client_key</code></em>,
<em class="parameter"><code><span class="type">char</span> *server_key</code></em>,
<em class="parameter"><code><span class="type">char</span> *stored_key</code></em>);</pre>
<p>Helper function to derive SCRAM ClientKey/ServerKey/StoredKey. The
<em class="parameter"><code>client_key</code></em>
, <em class="parameter"><code>server_key</code></em>
, and <em class="parameter"><code>stored_key</code></em>
buffers must have room to
hold digest for given <em class="parameter"><code>hash</code></em>
, use <a class="link" href="gsasl-gsasl.h.html#GSASL-HASH-MAX-SIZE:CAPS"><span class="type">GSASL_HASH_MAX_SIZE</span></a> which is
sufficient for all hashes.</p>
<div class="refsect3">
<a name="gsasl-scram-secrets-from-salted-password.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hash</p></td>
<td class="parameter_description"><p>a <a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><code class="literal">Gsasl_hash</code></a> element, e.g., <a class="link" href="gsasl-gsasl.h.html#GSASL-HASH-SHA256:CAPS"><span class="type">GSASL_HASH_SHA256</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>salted_password</p></td>
<td class="parameter_description"><p>input array with salted password.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>client_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived client key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>server_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived server key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stored_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived stored key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-scram-secrets-from-salted-password.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-scram-secrets-from-password"></a><h3>gsasl_scram_secrets_from_password ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_scram_secrets_from_password (<em class="parameter"><code><a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><span class="type">Gsasl_hash</span></a> hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *password</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> iteration_count</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *salt</code></em>,
<em class="parameter"><code><span class="type">size_t</span> saltlen</code></em>,
<em class="parameter"><code><span class="type">char</span> *salted_password</code></em>,
<em class="parameter"><code><span class="type">char</span> *client_key</code></em>,
<em class="parameter"><code><span class="type">char</span> *server_key</code></em>,
<em class="parameter"><code><span class="type">char</span> *stored_key</code></em>);</pre>
<p>Helper function to generate SCRAM secrets from a password. The
<em class="parameter"><code>salted_password</code></em>
, <em class="parameter"><code>client_key</code></em>
, <em class="parameter"><code>server_key</code></em>
, and <em class="parameter"><code>stored_key</code></em>
buffers
must have room to hold digest for given <em class="parameter"><code>hash</code></em>
, use
<a class="link" href="gsasl-gsasl.h.html#GSASL-HASH-MAX-SIZE:CAPS"><span class="type">GSASL_HASH_MAX_SIZE</span></a> which is sufficient for all hashes.</p>
<div class="refsect3">
<a name="gsasl-scram-secrets-from-password.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hash</p></td>
<td class="parameter_description"><p>a <a class="link" href="gsasl-gsasl.h.html#Gsasl-hash" title="enum Gsasl_hash"><code class="literal">Gsasl_hash</code></a> element, e.g., <a class="link" href="gsasl-gsasl.h.html#GSASL-HASH-SHA256:CAPS"><span class="type">GSASL_HASH_SHA256</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>input parameter with password.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iteration_count</p></td>
<td class="parameter_description"><p>number of PBKDF2 rounds to apply.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>salt</p></td>
<td class="parameter_description"><p>input character array of <em class="parameter"><code>saltlen</code></em>
length with salt for PBKDF2.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>saltlen</p></td>
<td class="parameter_description"><p>length of <em class="parameter"><code>salt</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>salted_password</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived salted password.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>client_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived client key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>server_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived server key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stored_key</p></td>
<td class="parameter_description"><p>pre-allocated output array with derived stored key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-scram-secrets-from-password.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if successful, or error code.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-simple-getpass"></a><h3>gsasl_simple_getpass ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_simple_getpass (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *username</code></em>,
<em class="parameter"><code><span class="type">char</span> **key</code></em>);</pre>
<p>Retrieve password for user from specified file. The buffer <em class="parameter"><code>key</code></em>
contain the password if this function is successful. The caller is
responsible for deallocating it.</p>
<p>The file should be on the UoW "MD5 Based Authentication" format,
which means it is in text format with comments denoted by # first
on the line, with user entries looking as "usernameTABpassword".
This function removes CR and LF at the end of lines before
processing. TAB, CR, and LF denote ASCII values 9, 13, and 10,
respectively.</p>
<div class="refsect3">
<a name="gsasl-simple-getpass.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>filename of file containing passwords.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>username</p></td>
<td class="parameter_description"><p>username string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>newly allocated output character array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-simple-getpass.returns"></a><h4>Returns</h4>
<p> Return <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> if output buffer contains the
password, <a class="link" href="gsasl-gsasl.h.html#GSASL-AUTHENTICATION-ERROR:CAPS"><code class="literal">GSASL_AUTHENTICATION_ERROR</code></a> if the user could not be
found, or other error code.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-base64-to"></a><h3>gsasl_base64_to ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_base64_to (<em class="parameter"><code>const <span class="type">char</span> *in</code></em>,
<em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>);</pre>
<p>Encode data as base64. The <em class="parameter"><code>out</code></em>
string is zero terminated, and
<em class="parameter"><code>outlen</code></em>
holds the length excluding the terminating zero. The <em class="parameter"><code>out</code></em>
buffer must be deallocated by the caller.</p>
<div class="refsect3">
<a name="gsasl-base64-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inlen</p></td>
<td class="parameter_description"><p>size of input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>pointer to newly allocated base64-encoded string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to size of newly allocated base64-encoded string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-base64-to.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> on success, or <a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a>
if input was too large or memory allocation fail.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-2.html#api-index-0.2.2">0.2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-base64-from"></a><h3>gsasl_base64_from ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_base64_from (<em class="parameter"><code>const <span class="type">char</span> *in</code></em>,
<em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>);</pre>
<p>Decode Base64 data. The <em class="parameter"><code>out</code></em>
buffer must be deallocated by the
caller.</p>
<div class="refsect3">
<a name="gsasl-base64-from.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>input byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inlen</p></td>
<td class="parameter_description"><p>size of input byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>pointer to newly allocated output byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to size of newly allocated output byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-base64-from.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> on success, <a class="link" href="gsasl-gsasl.h.html#GSASL-BASE64-ERROR:CAPS"><code class="literal">GSASL_BASE64_ERROR</code></a> if
input was invalid, and <a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a> on memory allocation
errors.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-2.html#api-index-0.2.2">0.2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-hex-to"></a><h3>gsasl_hex_to ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_hex_to (<em class="parameter"><code>const <span class="type">char</span> *in</code></em>,
<em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>);</pre>
<p>Hex encode data. The <em class="parameter"><code>out</code></em>
string is zero terminated, and <em class="parameter"><code>outlen</code></em>
holds the length excluding the terminating zero. The <em class="parameter"><code>out</code></em>
buffer
must be deallocated by the caller.</p>
<div class="refsect3">
<a name="gsasl-hex-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inlen</p></td>
<td class="parameter_description"><p>size of input byte array.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>pointer to newly allocated hex-encoded string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to size of newly allocated hex-encoded string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-hex-to.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> on success, or <a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a>
if input was too large or memory allocation fail.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-hex-from"></a><h3>gsasl_hex_from ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
gsasl_hex_from (<em class="parameter"><code>const <span class="type">char</span> *in</code></em>,
<em class="parameter"><code><span class="type">char</span> **out</code></em>,
<em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>);</pre>
<p>Decode hex data. The <em class="parameter"><code>out</code></em>
buffer must be deallocated by the
caller.</p>
<div class="refsect3">
<a name="gsasl-hex-from.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>input byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>pointer to newly allocated output byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to size of newly allocated output byte array</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gsasl-hex-from.returns"></a><h4>Returns</h4>
<p> Returns <a class="link" href="gsasl-gsasl.h.html#GSASL-OK:CAPS"><code class="literal">GSASL_OK</code></a> on success, <a class="link" href="gsasl-gsasl.h.html#GSASL-BASE64-ERROR:CAPS"><code class="literal">GSASL_BASE64_ERROR</code></a> if
input was invalid, and <a class="link" href="gsasl-gsasl.h.html#GSASL-MALLOC-ERROR:CAPS"><code class="literal">GSASL_MALLOC_ERROR</code></a> on memory allocation
errors.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gsasl-free"></a><h3>gsasl_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsasl_free (<em class="parameter"><code><span class="type">void</span> *ptr</code></em>);</pre>
<p>Invoke free(<em class="parameter"><code>ptr</code></em>
) to de-allocate memory pointer. Typically used on
strings allocated by other libgsasl functions.</p>
<p>This is useful on Windows where libgsasl is linked to one CRT and
the application is linked to another CRT. Then malloc/free will
not use the same heap. This happens if you build libgsasl using
mingw32 and the application with Visual Studio.</p>
<div class="refsect3">
<a name="gsasl-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ptr</p></td>
<td class="parameter_description"><p>memory pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-0-2-19.html#api-index-0.2.19">0.2.19</a></p>
</div>
</div>
<div class="refsect1">
<a name="gsasl-gsasl.h.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="Gsasl"></a><h3>Gsasl</h3>
<pre class="programlisting"> typedef struct Gsasl Gsasl;
</pre>
<p>Handle to global library context.</p>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-session"></a><h3>Gsasl_session</h3>
<pre class="programlisting"> typedef struct Gsasl_session Gsasl_session;
</pre>
<p>Handle to SASL session context.</p>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-rc"></a><h3>enum Gsasl_rc</h3>
<p>Error codes for library functions.</p>
<div class="refsect3">
<a name="Gsasl-rc.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-OK:CAPS"></a>GSASL_OK</p></td>
<td class="enum_member_description">
<p>Successful return code, guaranteed to be always 0.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NEEDS-MORE:CAPS"></a>GSASL_NEEDS_MORE</p></td>
<td class="enum_member_description">
<p>Mechanism expects another round-trip.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-UNKNOWN-MECHANISM:CAPS"></a>GSASL_UNKNOWN_MECHANISM</p></td>
<td class="enum_member_description">
<p>Application requested an unknown mechanism.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-MECHANISM-CALLED-TOO-MANY-TIMES:CAPS"></a>GSASL_MECHANISM_CALLED_TOO_MANY_TIMES</p></td>
<td class="enum_member_description">
<p>Application requested too
many round trips from mechanism.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-MALLOC-ERROR:CAPS"></a>GSASL_MALLOC_ERROR</p></td>
<td class="enum_member_description">
<p>Memory allocation failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-BASE64-ERROR:CAPS"></a>GSASL_BASE64_ERROR</p></td>
<td class="enum_member_description">
<p>Base64 encoding/decoding failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-CRYPTO-ERROR:CAPS"></a>GSASL_CRYPTO_ERROR</p></td>
<td class="enum_member_description">
<p>Cryptographic error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SASLPREP-ERROR:CAPS"></a>GSASL_SASLPREP_ERROR</p></td>
<td class="enum_member_description">
<p>Failed to prepare internationalized string.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-MECHANISM-PARSE-ERROR:CAPS"></a>GSASL_MECHANISM_PARSE_ERROR</p></td>
<td class="enum_member_description">
<p>Mechanism could not parse input.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-AUTHENTICATION-ERROR:CAPS"></a>GSASL_AUTHENTICATION_ERROR</p></td>
<td class="enum_member_description">
<p>Authentication has failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-INTEGRITY-ERROR:CAPS"></a>GSASL_INTEGRITY_ERROR</p></td>
<td class="enum_member_description">
<p>Application data integrity check failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-CLIENT-CODE:CAPS"></a>GSASL_NO_CLIENT_CODE</p></td>
<td class="enum_member_description">
<p>Library was built with client functionality.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-SERVER-CODE:CAPS"></a>GSASL_NO_SERVER_CODE</p></td>
<td class="enum_member_description">
<p>Library was built with server functionality.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-CALLBACK:CAPS"></a>GSASL_NO_CALLBACK</p></td>
<td class="enum_member_description">
<p>Application did not provide a callback.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-ANONYMOUS-TOKEN:CAPS"></a>GSASL_NO_ANONYMOUS_TOKEN</p></td>
<td class="enum_member_description">
<p>Could not get required anonymous token.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-AUTHID:CAPS"></a>GSASL_NO_AUTHID</p></td>
<td class="enum_member_description">
<p>Could not get required authentication
identity (username).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-AUTHZID:CAPS"></a>GSASL_NO_AUTHZID</p></td>
<td class="enum_member_description">
<p>Could not get required authorization identity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-PASSWORD:CAPS"></a>GSASL_NO_PASSWORD</p></td>
<td class="enum_member_description">
<p>Could not get required password.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-PASSCODE:CAPS"></a>GSASL_NO_PASSCODE</p></td>
<td class="enum_member_description">
<p>Could not get required SecurID PIN.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-PIN:CAPS"></a>GSASL_NO_PIN</p></td>
<td class="enum_member_description">
<p>Could not get required SecurID PIN.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-SERVICE:CAPS"></a>GSASL_NO_SERVICE</p></td>
<td class="enum_member_description">
<p>Could not get required service name.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-HOSTNAME:CAPS"></a>GSASL_NO_HOSTNAME</p></td>
<td class="enum_member_description">
<p>Could not get required hostname.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-CB-TLS-UNIQUE:CAPS"></a>GSASL_NO_CB_TLS_UNIQUE</p></td>
<td class="enum_member_description">
<p>Could not get required tls-unique CB.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-SAML20-IDP-IDENTIFIER:CAPS"></a>GSASL_NO_SAML20_IDP_IDENTIFIER</p></td>
<td class="enum_member_description">
<p>Could not get required SAML IdP.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-SAML20-REDIRECT-URL:CAPS"></a>GSASL_NO_SAML20_REDIRECT_URL</p></td>
<td class="enum_member_description">
<p>Could not get required SAML
redirect URL.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-OPENID20-REDIRECT-URL:CAPS"></a>GSASL_NO_OPENID20_REDIRECT_URL</p></td>
<td class="enum_member_description">
<p>Could not get required OpenID
redirect URL.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-NO-CB-TLS-EXPORTER:CAPS"></a>GSASL_NO_CB_TLS_EXPORTER</p></td>
<td class="enum_member_description">
<p>Could not get required tls-exporter CB.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-RELEASE-BUFFER-ERROR:CAPS"></a>GSASL_GSSAPI_RELEASE_BUFFER_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-IMPORT-NAME-ERROR:CAPS"></a>GSASL_GSSAPI_IMPORT_NAME_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-INIT-SEC-CONTEXT-ERROR:CAPS"></a>GSASL_GSSAPI_INIT_SEC_CONTEXT_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-ACCEPT-SEC-CONTEXT-ERROR:CAPS"></a>GSASL_GSSAPI_ACCEPT_SEC_CONTEXT_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-UNWRAP-ERROR:CAPS"></a>GSASL_GSSAPI_UNWRAP_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-WRAP-ERROR:CAPS"></a>GSASL_GSSAPI_WRAP_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-ACQUIRE-CRED-ERROR:CAPS"></a>GSASL_GSSAPI_ACQUIRE_CRED_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-DISPLAY-NAME-ERROR:CAPS"></a>GSASL_GSSAPI_DISPLAY_NAME_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-UNSUPPORTED-PROTECTION-ERROR:CAPS"></a>GSASL_GSSAPI_UNSUPPORTED_PROTECTION_ERROR</p></td>
<td class="enum_member_description">
<p>An unsupported
quality-of-protection layer was requeted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SECURID-SERVER-NEED-ADDITIONAL-PASSCODE:CAPS"></a>GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE</p></td>
<td class="enum_member_description">
<p>SecurID mechanism
needs an additional passcode.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SECURID-SERVER-NEED-NEW-PIN:CAPS"></a>GSASL_SECURID_SERVER_NEED_NEW_PIN</p></td>
<td class="enum_member_description">
<p>SecurID mechanism
needs an new PIN.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-ENCAPSULATE-TOKEN-ERROR:CAPS"></a>GSASL_GSSAPI_ENCAPSULATE_TOKEN_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-DECAPSULATE-TOKEN-ERROR:CAPS"></a>GSASL_GSSAPI_DECAPSULATE_TOKEN_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-INQUIRE-MECH-FOR-SASLNAME-ERROR:CAPS"></a>GSASL_GSSAPI_INQUIRE_MECH_FOR_SASLNAME_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-TEST-OID-SET-MEMBER-ERROR:CAPS"></a>GSASL_GSSAPI_TEST_OID_SET_MEMBER_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-RELEASE-OID-SET-ERROR:CAPS"></a>GSASL_GSSAPI_RELEASE_OID_SET_ERROR</p></td>
<td class="enum_member_description">
<p>GSS-API library call error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-property"></a><h3>enum Gsasl_property</h3>
<p>Callback/property types.</p>
<div class="refsect3">
<a name="Gsasl-property.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-AUTHID:CAPS"></a>GSASL_AUTHID</p></td>
<td class="enum_member_description">
<p>Authentication identity (username).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-AUTHZID:CAPS"></a>GSASL_AUTHZID</p></td>
<td class="enum_member_description">
<p>Authorization identity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-PASSWORD:CAPS"></a>GSASL_PASSWORD</p></td>
<td class="enum_member_description">
<p>Password.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-ANONYMOUS-TOKEN:CAPS"></a>GSASL_ANONYMOUS_TOKEN</p></td>
<td class="enum_member_description">
<p>Anonymous identifier.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SERVICE:CAPS"></a>GSASL_SERVICE</p></td>
<td class="enum_member_description">
<p>Service name</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HOSTNAME:CAPS"></a>GSASL_HOSTNAME</p></td>
<td class="enum_member_description">
<p>Host name.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-GSSAPI-DISPLAY-NAME:CAPS"></a>GSASL_GSSAPI_DISPLAY_NAME</p></td>
<td class="enum_member_description">
<p>GSS-API credential principal name.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-PASSCODE:CAPS"></a>GSASL_PASSCODE</p></td>
<td class="enum_member_description">
<p>SecurID passcode.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SUGGESTED-PIN:CAPS"></a>GSASL_SUGGESTED_PIN</p></td>
<td class="enum_member_description">
<p>SecurID suggested PIN.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-PIN:CAPS"></a>GSASL_PIN</p></td>
<td class="enum_member_description">
<p>SecurID PIN.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-REALM:CAPS"></a>GSASL_REALM</p></td>
<td class="enum_member_description">
<p>User realm.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-DIGEST-MD5-HASHED-PASSWORD:CAPS"></a>GSASL_DIGEST_MD5_HASHED_PASSWORD</p></td>
<td class="enum_member_description">
<p>Pre-computed hashed DIGEST-MD5
password, to avoid storing passwords in the clear.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-QOPS:CAPS"></a>GSASL_QOPS</p></td>
<td class="enum_member_description">
<p>Set of quality-of-protection values.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-QOP:CAPS"></a>GSASL_QOP</p></td>
<td class="enum_member_description">
<p>Quality-of-protection value.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SCRAM-ITER:CAPS"></a>GSASL_SCRAM_ITER</p></td>
<td class="enum_member_description">
<p>Number of iterations in password-to-key hashing.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SCRAM-SALT:CAPS"></a>GSASL_SCRAM_SALT</p></td>
<td class="enum_member_description">
<p>Salt for password-to-key hashing.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SCRAM-SALTED-PASSWORD:CAPS"></a>GSASL_SCRAM_SALTED_PASSWORD</p></td>
<td class="enum_member_description">
<p>Hex-encoded hashed/salted password.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SCRAM-SERVERKEY:CAPS"></a>GSASL_SCRAM_SERVERKEY</p></td>
<td class="enum_member_description">
<p>Hex-encoded SCRAM ServerKey derived
from users' passowrd.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SCRAM-STOREDKEY:CAPS"></a>GSASL_SCRAM_STOREDKEY</p></td>
<td class="enum_member_description">
<p>Hex-encoded SCRAM StoredKey derived
from users' passowrd.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-CB-TLS-UNIQUE:CAPS"></a>GSASL_CB_TLS_UNIQUE</p></td>
<td class="enum_member_description">
<p>Base64 encoded tls-unique channel binding.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SAML20-IDP-IDENTIFIER:CAPS"></a>GSASL_SAML20_IDP_IDENTIFIER</p></td>
<td class="enum_member_description">
<p>SAML20 user IdP URL.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SAML20-REDIRECT-URL:CAPS"></a>GSASL_SAML20_REDIRECT_URL</p></td>
<td class="enum_member_description">
<p>SAML 2.0 URL to access in browser.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-OPENID20-REDIRECT-URL:CAPS"></a>GSASL_OPENID20_REDIRECT_URL</p></td>
<td class="enum_member_description">
<p>OpenID 2.0 URL to access in browser.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-OPENID20-OUTCOME-DATA:CAPS"></a>GSASL_OPENID20_OUTCOME_DATA</p></td>
<td class="enum_member_description">
<p>OpenID 2.0 authentication outcome data.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-CB-TLS-EXPORTER:CAPS"></a>GSASL_CB_TLS_EXPORTER</p></td>
<td class="enum_member_description">
<p>Base64 encoded tls-exporter channel binding.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-SAML20-AUTHENTICATE-IN-BROWSER:CAPS"></a>GSASL_SAML20_AUTHENTICATE_IN_BROWSER</p></td>
<td class="enum_member_description">
<p>Request to perform SAML 2.0
authentication in browser.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-OPENID20-AUTHENTICATE-IN-BROWSER:CAPS"></a>GSASL_OPENID20_AUTHENTICATE_IN_BROWSER</p></td>
<td class="enum_member_description">
<p>Request to perform OpenID 2.0
authentication in browser.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-SIMPLE:CAPS"></a>GSASL_VALIDATE_SIMPLE</p></td>
<td class="enum_member_description">
<p>Request for simple validation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-EXTERNAL:CAPS"></a>GSASL_VALIDATE_EXTERNAL</p></td>
<td class="enum_member_description">
<p>Request for validation of EXTERNAL.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-ANONYMOUS:CAPS"></a>GSASL_VALIDATE_ANONYMOUS</p></td>
<td class="enum_member_description">
<p>Request for validation of ANONYMOUS.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-GSSAPI:CAPS"></a>GSASL_VALIDATE_GSSAPI</p></td>
<td class="enum_member_description">
<p>Request for validation of GSSAPI/GS2.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-SECURID:CAPS"></a>GSASL_VALIDATE_SECURID</p></td>
<td class="enum_member_description">
<p>Reqest for validation of SecurID.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-SAML20:CAPS"></a>GSASL_VALIDATE_SAML20</p></td>
<td class="enum_member_description">
<p>Reqest for validation of SAML20.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-VALIDATE-OPENID20:CAPS"></a>GSASL_VALIDATE_OPENID20</p></td>
<td class="enum_member_description">
<p>Reqest for validation of OpenID 2.0 login.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-mechname-limits"></a><h3>enum Gsasl_mechname_limits</h3>
<p>SASL mechanisms are named by strings, from 1 to 20 characters in
length, consisting of upper-case letters, digits, hyphens, and/or
underscores. See also <a class="link" href="gsasl-gsasl.h.html#gsasl-mechanism-name-p" title="gsasl_mechanism_name_p ()"><code class="function">gsasl_mechanism_name_p()</code></a>.</p>
<div class="refsect3">
<a name="Gsasl-mechname-limits.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-MIN-MECHANISM-SIZE:CAPS"></a>GSASL_MIN_MECHANISM_SIZE</p></td>
<td class="enum_member_description">
<p>Minimum size of mechanism name strings.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-MAX-MECHANISM-SIZE:CAPS"></a>GSASL_MAX_MECHANISM_SIZE</p></td>
<td class="enum_member_description">
<p>Maximum size of mechanism name strings.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-qop"></a><h3>enum Gsasl_qop</h3>
<p>Quality of Protection types (DIGEST-MD5 and GSSAPI). The
integrity and confidentiality values is about application data
wrapping. We recommend that you use <em class="parameter"><code>GSASL_QOP_AUTH</code></em>
with TLS as
that combination is generally more secure and have better chance
of working than the integrity/confidentiality layers of SASL.</p>
<div class="refsect3">
<a name="Gsasl-qop.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-QOP-AUTH:CAPS"></a>GSASL_QOP_AUTH</p></td>
<td class="enum_member_description">
<p>Authentication only.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-QOP-AUTH-INT:CAPS"></a>GSASL_QOP_AUTH_INT</p></td>
<td class="enum_member_description">
<p>Authentication and integrity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-QOP-AUTH-CONF:CAPS"></a>GSASL_QOP_AUTH_CONF</p></td>
<td class="enum_member_description">
<p>Authentication, integrity and confidentiality.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-saslprep-flags"></a><h3>enum Gsasl_saslprep_flags</h3>
<p>Flags for the SASLprep function, see <a class="link" href="gsasl-gsasl.h.html#gsasl-saslprep" title="gsasl_saslprep ()"><code class="function">gsasl_saslprep()</code></a>. For
background, see the GNU Libidn documentation.</p>
<div class="refsect3">
<a name="Gsasl-saslprep-flags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="GSASL-ALLOW-UNASSIGNED:CAPS"></a>GSASL_ALLOW_UNASSIGNED</p></td>
<td class="enum_member_description">
<p>Allow unassigned code points.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-hash"></a><h3>enum Gsasl_hash</h3>
<p>Hash functions. You may use <a class="link" href="gsasl-gsasl.h.html#gsasl-hash-length" title="gsasl_hash_length ()"><code class="function">gsasl_hash_length()</code></a> to get the
output size of a hash function.</p>
<p>Currently only used as parameter to
<a class="link" href="gsasl-gsasl.h.html#gsasl-scram-secrets-from-salted-password" title="gsasl_scram_secrets_from_salted_password ()"><code class="function">gsasl_scram_secrets_from_salted_password()</code></a> and
<a class="link" href="gsasl-gsasl.h.html#gsasl-scram-secrets-from-password" title="gsasl_scram_secrets_from_password ()"><code class="function">gsasl_scram_secrets_from_password()</code></a> to specify for which SCRAM
mechanism to prepare secrets for.</p>
<div class="refsect3">
<a name="Gsasl-hash.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HASH-SHA1:CAPS"></a>GSASL_HASH_SHA1</p></td>
<td class="enum_member_description">
<p>Hash function SHA-1.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HASH-SHA256:CAPS"></a>GSASL_HASH_SHA256</p></td>
<td class="enum_member_description">
<p>Hash function SHA-256.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="Gsasl-hash-length"></a><h3>enum Gsasl_hash_length</h3>
<p>Identifiers specifying the output size of hash functions.</p>
<p>These can be used when statically allocating the buffers needed
for, e.g., <a class="link" href="gsasl-gsasl.h.html#gsasl-scram-secrets-from-password" title="gsasl_scram_secrets_from_password ()"><code class="function">gsasl_scram_secrets_from_password()</code></a>.</p>
<div class="refsect3">
<a name="Gsasl-hash-length.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HASH-SHA1-SIZE:CAPS"></a>GSASL_HASH_SHA1_SIZE</p></td>
<td class="enum_member_description">
<p>Output size of hash function SHA-1.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HASH-SHA256-SIZE:CAPS"></a>GSASL_HASH_SHA256_SIZE</p></td>
<td class="enum_member_description">
<p>Output size of hash function SHA-256.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSASL-HASH-MAX-SIZE:CAPS"></a>GSASL_HASH_MAX_SIZE</p></td>
<td class="enum_member_description">
<p>Maximum output size of any <a class="link" href="gsasl-gsasl.h.html#Gsasl-hash-length" title="enum Gsasl_hash_length"><code class="literal">Gsasl_hash_length</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-1-10.html#api-index-1.10">1.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
