summaryrefslogtreecommitdiff
path: root/docs/Samba-Developers-Guide.html
blob: 7c008667af4d72e69746d3d958a90a6194881cee (plain) 
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
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML
><HEAD
><TITLE
>SAMBA Developers Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"></HEAD
><BODY
CLASS="BOOK"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="BOOK"
><A
NAME="SAMBA-DEVELOPER-DOCUMENTATION"><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="SAMBA-DEVELOPER-DOCUMENTATION">SAMBA Developers Guide</H1
><H3
CLASS="AUTHOR"
><A
NAME="AEN4">SAMBA Team</H3
><HR></DIV
><HR><H1
><A
NAME="AEN8">Abstract</H1
><P
><I
CLASS="EMPHASIS"
>Last Update</I
> : Mon Sep 30 15:23:53 CDT 2002</P
><P
>This book is a collection of documents that might be useful for 
people developing samba or those interested in doing so.
It's nothing more than a collection of documents written by samba developers about 
the internals of various parts of samba and the SMB protocol. It's still incomplete.
The most recent version of this document
can be found at <A
HREF="http://devel.samba.org/"
TARGET="_top"
>http://devel.samba.org/</A
>.
Please send updates to <A
HREF="mailto:jelmer@samba.org"
TARGET="_top"
>jelmer@samba.org</A
>.</P
><P
>This documentation is distributed under the GNU General Public License (GPL) 
version 2.  A copy of the license is included with the Samba source
distribution.  A copy can be found on-line at <A
HREF="http://www.fsf.org/licenses/gpl.txt"
TARGET="_top"
>http://www.fsf.org/licenses/gpl.txt</A
></P
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#NETBIOS"
>Definition of NetBIOS Protocol and Name Resolution Modes</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN24"
>NETBIOS</A
></DT
><DT
><A
HREF="#AEN35"
>BROADCAST NetBIOS</A
></DT
><DT
><A
HREF="#AEN39"
>NBNS NetBIOS</A
></DT
></DL
></DD
><DT
><A
HREF="#ARCHITECTURE"
>Samba Architecture</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN54"
>Introduction</A
></DT
><DT
><A
HREF="#AEN65"
>Multithreading and Samba</A
></DT
><DT
><A
HREF="#AEN70"
>Threading smbd</A
></DT
><DT
><A
HREF="#AEN86"
>Threading nmbd</A
></DT
><DT
><A
HREF="#AEN92"
>nbmd Design</A
></DT
></DL
></DD
><DT
><A
HREF="#DEBUG"
>The samba DEBUG system</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN103"
>New Output Syntax</A
></DT
><DT
><A
HREF="#AEN128"
>The DEBUG() Macro</A
></DT
><DT
><A
HREF="#AEN151"
>The DEBUGADD() Macro</A
></DT
><DT
><A
HREF="#AEN159"
>The DEBUGLVL() Macro</A
></DT
><DT
><A
HREF="#AEN179"
>New Functions</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN181"
>dbgtext()</A
></DT
><DT
><A
HREF="#AEN184"
>dbghdr()</A
></DT
><DT
><A
HREF="#AEN188"
>format_debug_text()</A
></DT
></DL
></DD
></DL
></DD
><DT
><A
HREF="#CODINGSUGGESTIONS"
>Coding Suggestions</A
></DT
><DT
><A
HREF="#INTERNALS"
>Samba Internals</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN284"
>Character Handling</A
></DT
><DT
><A
HREF="#AEN288"
>The new functions</A
></DT
><DT
><A
HREF="#AEN317"
>Macros in byteorder.h</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN320"
>CVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN323"
>PVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN326"
>SCVAL(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN329"
>SVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN332"
>IVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN335"
>SVALS(buf,pos)</A
></DT
><DT
><A
HREF="#AEN338"
>IVALS(buf,pos)</A
></DT
><DT
><A
HREF="#AEN341"
>SSVAL(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN344"
>SIVAL(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN347"
>SSVALS(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN350"
>SIVALS(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN353"
>RSVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN356"
>RIVAL(buf,pos)</A
></DT
><DT
><A
HREF="#AEN359"
>RSSVAL(buf,pos,val)</A
></DT
><DT
><A
HREF="#AEN362"
>RSIVAL(buf,pos,val)</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN365"
>LAN Manager Samba API</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN371"
>Parameters</A
></DT
><DT
><A
HREF="#AEN406"
>Return value</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN420"
>Code character table</A
></DT
></DL
></DD
><DT
><A
HREF="#PARSING"
>The smb.conf file</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN451"
>Lexical Analysis</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN472"
>Handling of Whitespace</A
></DT
><DT
><A
HREF="#AEN484"
>Handling of Line Continuation</A
></DT
><DT
><A
HREF="#AEN495"
>Line Continuation Quirks</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN515"
>Syntax</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN530"
>About params.c</A
></DT
></DL
></DD
></DL
></DD
><DT
><A
HREF="#UNIX-SMB"
>NetBIOS in a Unix World</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN540"
>Introduction</A
></DT
><DT
><A
HREF="#AEN544"
>Usernames</A
></DT
><DT
><A
HREF="#AEN552"
>File Ownership</A
></DT
><DT
><A
HREF="#AEN557"
>Passwords</A
></DT
><DT
><A
HREF="#AEN563"
>Locking</A
></DT
><DT
><A
HREF="#AEN570"
>Deny Modes</A
></DT
><DT
><A
HREF="#AEN574"
>Trapdoor UIDs</A
></DT
><DT
><A
HREF="#AEN578"
>Port numbers</A
></DT
><DT
><A
HREF="#AEN583"
>Protocol Complexity</A
></DT
></DL
></DD
><DT
><A
HREF="#TRACING"
>Tracing samba system calls</A
></DT
><DT
><A
HREF="#NTDOMAIN"
>NT Domain RPC's</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN651"
>Introduction</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN687"
>Sources</A
></DT
><DT
><A
HREF="#AEN694"
>Credits</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN701"
>Notes and Structures</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN703"
>Notes</A
></DT
><DT
><A
HREF="#AEN716"
>Enumerations</A
></DT
><DT
><A
HREF="#AEN774"
>Structures</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN1570"
>MSRPC over Transact Named Pipe</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN1573"
>MSRPC Pipes</A
></DT
><DT
><A
HREF="#AEN1587"
>Header</A
></DT
><DT
><A
HREF="#AEN1841"
>Tail</A
></DT
><DT
><A
HREF="#AEN1853"
>RPC Bind / Bind Ack</A
></DT
><DT
><A
HREF="#AEN1897"
>NTLSA Transact Named Pipe</A
></DT
><DT
><A
HREF="#AEN1938"
>LSA Open Policy</A
></DT
><DT
><A
HREF="#AEN1972"
>LSA Query Info Policy</A
></DT
><DT
><A
HREF="#AEN2000"
>LSA Enumerate Trusted Domains</A
></DT
><DT
><A
HREF="#AEN2024"
>LSA Open Secret</A
></DT
><DT
><A
HREF="#AEN2053"
>LSA Close</A
></DT
><DT
><A
HREF="#AEN2070"
>LSA Lookup SIDS</A
></DT
><DT
><A
HREF="#AEN2129"
>LSA Lookup Names</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN2192"
>NETLOGON rpc Transact Named Pipe</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2231"
>LSA Request Challenge</A
></DT
><DT
><A
HREF="#AEN2266"
>LSA Authenticate 2</A
></DT
><DT
><A
HREF="#AEN2305"
>LSA Server Password Set</A
></DT
><DT
><A
HREF="#AEN2334"
>LSA SAM Logon</A
></DT
><DT
><A
HREF="#AEN2358"
>LSA SAM Logoff</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN2381"
>\\MAILSLOT\NET\NTLOGON</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2385"
>Query for PDC</A
></DT
><DT
><A
HREF="#AEN2459"
>SAM Logon</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN2549"
>SRVSVC Transact Named Pipe</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2561"
>Net Share Enum</A
></DT
><DT
><A
HREF="#AEN2622"
>Net Server Get Info</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN2653"
>Cryptographic side of NT Domain Authentication</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2655"
>Definitions</A
></DT
><DT
><A
HREF="#AEN2698"
>Protocol</A
></DT
><DT
><A
HREF="#AEN2708"
>Comments</A
></DT
></DL
></DD
><DT
><A
HREF="#AEN2715"
>SIDs and RIDs</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2723"
>Well-known SIDs</A
></DT
><DT
><A
HREF="#AEN2811"
>Well-known RIDS</A
></DT
></DL
></DD
></DL
></DD
><DT
><A
HREF="#PRINTING"
>Samba Printing Internals</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN2895"
>Abstract</A
></DT
><DT
><A
HREF="#AEN2898"
>Printing Interface to Various Back ends</A
></DT
><DT
><A
HREF="#AEN2924"
>Print Queue TDB's</A
></DT
><DT
><A
HREF="#AEN2958"
>ChangeID &#38; Client Caching of Printer Information</A
></DT
><DT
><A
HREF="#AEN2961"
>Windows NT/2K Printer Change Notify</A
></DT
></DL
></DD
><DT
><A
HREF="#WINS"
>Samba WINS Internals</A
></DT
><DD
><DL
><DT
><A
HREF="#AEN3032"
>WINS Failover</A
></DT
></DL
></DD
></DL
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="NETBIOS">Definition of NetBIOS Protocol and Name Resolution Modes</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN24">NETBIOS</H2
><P
>NetBIOS runs over the following tranports: TCP/IP; NetBEUI and IPX/SPX.
Samba only uses NetBIOS over TCP/IP.  For details on the TCP/IP NetBIOS 
Session Service NetBIOS Datagram Service, and NetBIOS Names, see
rfc1001.txt and rfc1002.txt.</P
><P
> 
NetBEUI is a raw NetBIOS frame protocol implementation that allows NetBIOS
datagrams to be sent out over the 'wire' embedded within LLC frames.
NetBEUI is not required when using NetBIOS over TCP/IP protocols and it
is preferable NOT to install NetBEUI if it can be avoided.</P
><P
> 
IPX/SPX is also not required when using NetBIOS over TCP/IP, and it is
preferable NOT to install the IPX/SPX transport unless you are using Novell
servers.  At the very least, it is recommended that you do not install
'NetBIOS over IPX/SPX'.</P
><P
>[When installing Windows 95, you will find that NetBEUI and IPX/SPX are
installed as the default protocols.  This is because they are the simplest
to manage: no Windows 95 user-configuration is required].</P
><P
> 
NetBIOS applications (such as samba) offer their services (for example,
SMB file and print sharing) on a NetBIOS name.  They must claim this name
on the network before doing so.  The NetBIOS session service will then
accept connections on the application's behalf (on the NetBIOS name
claimed by the application).  A NetBIOS session between the application
and the client can then commence.</P
><P
> 
NetBIOS names consist of 15 characters plus a 'type' character.  This is
similar, in concept, to an IP address and a TCP port number, respectively.
A NetBIOS-aware application on a host will offer different services under
different NetBIOS name types, just as a host will offer different TCP/IP
services on different port numbers.</P
><P
> 
NetBIOS names must be claimed on a network, and must be defended.  The use
of NetBIOS names is most suitable on a single subnet; a Local Area Network
or a Wide Area Network.</P
><P
> 
NetBIOS names are either UNIQUE or GROUP.  Only one application can claim a
UNIQUE NetBIOS name on a network.</P
><P
>There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN35">BROADCAST NetBIOS</H2
><P
> 
Clients can claim names, and therefore offer services on successfully claimed
names, on their broadcast-isolated subnet.  One way to get NetBIOS services
(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and
SMB file/print sharing: see cifs4.txt) working on a LAN or WAN is to make
your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139.</P
><P
> 
This, however, is not recommended.  If you have a large LAN or WAN, you will
find that some of your hosts spend 95 percent of their time dealing with
broadcast traffic.  [If you have IPX/SPX on your LAN or WAN, you will find
that this is already happening: a packet analyzer will show, roughly
every twelve minutes, great swathes of broadcast traffic!].</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN39">NBNS NetBIOS</H2
><P
>rfc1001.txt describes, amongst other things, the implementation and use
of, a 'NetBIOS Name Service'.  NT/AS offers 'Windows Internet Name Service'
which is fully rfc1001/2 compliant, but has had to take specific action
with certain NetBIOS names in order to make it useful.  (for example, it
deals with the registration of &#60;1c&#62; &#60;1d&#62; &#60;1e&#62; names all in different ways.
I recommend the reading of the Microsoft WINS Server Help files for full
details).</P
><P
> 
The use of a WINS server cuts down on broadcast network traffic for
NetBIOS name resolution.  It has the effect of pulling all the broadcast
isolated subnets together into a single NetBIOS scope, across your LAN
or WAN, while avoiding the use of TCP/IP broadcast packets.</P
><P
>When you have a WINS server on your LAN, WINS clients will be able to
contact the WINS server to resolve NetBIOS names.  Note that only those
WINS clients that have registered with the same WINS server will be
visible.  The WINS server _can_ have static NetBIOS entries added to its
database (usually for security reasons you might want to consider putting
your domain controllers or other important servers as static entries,
but you should not rely on this as your sole means of security), but for
the most part, NetBIOS names are registered dynamically.</P
><P
>This provides some confusion for lots of people, and is worth mentioning
here:  a Browse Server is NOT a WINS Server, even if these services are
implemented in the same application.  A Browse Server _needs_ a WINS server
because a Browse Server is a WINS client, which is _not_ the same thing].</P
><P
>Clients can claim names, and therefore offer services on successfully claimed
names, on their broadcast-isolated subnet.  One way to get NetBIOS services
(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and
SMB file/print sharing: see cifs6.txt) working on a LAN or WAN is to make
your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139.
You will find, however, if you do this on a large LAN or a WAN, that your
network is completely swamped by NetBIOS and browsing packets, which is why
WINS was developed to minimise the necessity of broadcast traffic.</P
><P
> 
WINS Clients therefore claim names from the WINS server.  If the WINS
server allows them to register a name, the client's NetBIOS session service
can then offer services on this name.  Other WINS clients will then
contact the WINS server to resolve a NetBIOS name.</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="ARCHITECTURE">Samba Architecture</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN54">Introduction</H2
><P
>This document gives a general overview of how Samba works
internally. The Samba Team has tried to come up with a model which is
the best possible compromise between elegance, portability, security
and the constraints imposed by the very messy SMB and CIFS
protocol. </P
><P
>It also tries to answer some of the frequently asked questions such as:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	Is Samba secure when running on Unix? The xyz platform?
	What about the root priveliges issue?</P
></LI
><LI
><P
>Pros and cons of multithreading in various parts of Samba</P
></LI
><LI
><P
>Why not have a separate process for name resolution, WINS, and browsing?</P
></LI
></OL
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN65">Multithreading and Samba</H2
><P
>People sometimes tout threads as a uniformly good thing. They are very
nice in their place but are quite inappropriate for smbd. nmbd is
another matter, and multi-threading it would be very nice. </P
><P
>The short version is that smbd is not multithreaded, and alternative
servers that take this approach under Unix (such as Syntax, at the
time of writing) suffer tremendous performance penalties and are less
robust. nmbd is not threaded either, but this is because it is not
possible to do it while keeping code consistent and portable across 35
or more platforms. (This drawback also applies to threading smbd.)</P
><P
>The longer versions is that there are very good reasons for not making
smbd multi-threaded.  Multi-threading would actually make Samba much
slower, less scalable, less portable and much less robust. The fact
that we use a separate process for each connection is one of Samba's
biggest advantages.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN70">Threading smbd</H2
><P
>A few problems that would arise from a threaded smbd are:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	It's not only to create threads instead of processes, but you
	must care about all variables if they have to be thread specific
	(currently they would be global).</P
></LI
><LI
><P
>	if one thread dies (eg. a seg fault) then all threads die. We can
	immediately throw robustness out the window.</P
></LI
><LI
><P
>	many of the system calls we make are blocking. Non-blocking
	equivalents of many calls are either not available or are awkward (and
	slow) to use. So while we block in one thread all clients are
	waiting. Imagine if one share is a slow NFS filesystem and the others 
	are fast, we will end up slowing all clients to the speed of NFS.</P
></LI
><LI
><P
>	you can't run as a different uid in different threads. This means
	we would have to switch uid/gid on _every_ SMB packet. It would be
	horrendously slow.</P
></LI
><LI
><P
>	the per process file descriptor limit would mean that we could only
	support a limited number of clients.</P
></LI
><LI
><P
>	we couldn't use the system locking calls as the locking context of
	fcntl() is a process, not a thread.</P
></LI
></OL
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN86">Threading nmbd</H2
><P
>This would be ideal, but gets sunk by portability requirements.</P
><P
>Andrew tried to write a test threads library for nmbd that used only
ansi-C constructs (using setjmp and longjmp). Unfortunately some OSes
defeat this by restricting longjmp to calling addresses that are
shallower than the current address on the stack (apparently AIX does
this). This makes a truly portable threads library impossible. So to
support all our current platforms we would have to code nmbd both with
and without threads, and as the real aim of threads is to make the
code clearer we would not have gained anything. (it is a myth that
threads make things faster. threading is like recursion, it can make
things clear but the same thing can always be done faster by some
other method)</P
><P
>Chris tried to spec out a general design that would abstract threading
vs separate processes (vs other methods?) and make them accessible
through some general API. This doesn't work because of the data
sharing requirements of the protocol (packets in the future depending
on packets now, etc.) At least, the code would work but would be very
clumsy, and besides the fork() type model would never work on Unix. (Is there an OS that it would work on, for nmbd?)</P
><P
>A fork() is cheap, but not nearly cheap enough to do on every UDP
packet that arrives. Having a pool of processes is possible but is
nasty to program cleanly due to the enormous amount of shared data (in
complex structures) between the processes. We can't rely on each
platform having a shared memory system.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN92">nbmd Design</H2
><P
>Originally Andrew used recursion to simulate a multi-threaded
environment, which use the stack enormously and made for really
confusing debugging sessions. Luke Leighton rewrote it to use a
queuing system that keeps state information on each packet.  The
first version used a single structure which was used by all the
pending states.  As the initialisation of this structure was
done by adding arguments, as the functionality developed, it got
pretty messy.  So, it was replaced with a higher-order function
and a pointer to a user-defined memory block.  This suddenly
made things much simpler: large numbers of functions could be
made static, and modularised.  This is the same principle as used
in NT's kernel, and achieves the same effect as threads, but in
a single process.</P
><P
>Then Jeremy rewrote nmbd. The packet data in nmbd isn't what's on the
wire. It's a nice format that is very amenable to processing but still
keeps the idea of a distinct packet. See "struct packet_struct" in
nameserv.h.  It has all the detail but none of the on-the-wire
mess. This makes it ideal for using in disk or memory-based databases
for browsing and WINS support. </P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="DEBUG">The samba DEBUG system</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN103">New Output Syntax</H2
><P
>   The syntax of a debugging log file is represented as:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>  &#62;debugfile&#60; :== { &#62;debugmsg&#60; }

  &#62;debugmsg&#60;  :== &#62;debughdr&#60; '\n' &#62;debugtext&#60;

  &#62;debughdr&#60;  :== '[' TIME ',' LEVEL ']' FILE ':' [FUNCTION] '(' LINE ')'

  &#62;debugtext&#60; :== { &#62;debugline&#60; }

  &#62;debugline&#60; :== TEXT '\n'</PRE
></TD
></TR
></TABLE
></P
><P
>TEXT is a string of characters excluding the newline character.</P
><P
>LEVEL is the DEBUG level of the message (an integer in the range
		0..10).</P
><P
>TIME is a timestamp.</P
><P
>FILE is the name of the file from which the debug message was
generated.</P
><P
>FUNCTION is the function from which the debug message was generated.</P
><P
>LINE is the line number of the debug statement that generated the
message.</P
><P
>Basically, what that all means is:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>A debugging log file is made up of debug messages.</P
></LI
><LI
><P
>Each debug message is made up of a header and text. The header is
separated from the text by a newline.</P
></LI
><LI
><P
>The header begins with the timestamp and debug level of the
message enclosed in brackets. The filename, function, and line
number at which the message was generated follow. The filename is
terminated by a colon, and the function name is terminated by the
parenthesis which contain the line number. Depending upon the
compiler, the function name may be missing (it is generated by the
__FUNCTION__ macro, which is not universally implemented, dangit).</P
></LI
><LI
><P
>The message text is made up of zero or more lines, each terminated
by a newline.</P
></LI
></OL
><P
>Here's some example output:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    [1998/08/03 12:55:25, 1] nmbd.c:(659)
      Netbios nameserver version 1.9.19-prealpha started.
      Copyright Andrew Tridgell 1994-1997
    [1998/08/03 12:55:25, 3] loadparm.c:(763)
      Initializing global parameters</PRE
></TD
></TR
></TABLE
></P
><P
>Note that in the above example the function names are not listed on
the header line. That's because the example above was generated on an
SGI Indy, and the SGI compiler doesn't support the __FUNCTION__ macro.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN128">The DEBUG() Macro</H2
><P
>Use of the DEBUG() macro is unchanged. DEBUG() takes two parameters.
The first is the message level, the second is the body of a function
call to the Debug1() function.</P
><P
>That's confusing.</P
><P
>Here's an example which may help a bit. If you would write</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>printf( "This is a %s message.\n", "debug" );</PRE
></TD
></TR
></TABLE
></P
><P
>to send the output to stdout, then you would write</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>DEBUG( 0, ( "This is a %s message.\n", "debug" ) );</PRE
></TD
></TR
></TABLE
></P
><P
>to send the output to the debug file.  All of the normal printf()
formatting escapes work.</P
><P
>Note that in the above example the DEBUG message level is set to 0.
Messages at level 0 always print.  Basically, if the message level is
less than or equal to the global value DEBUGLEVEL, then the DEBUG
statement is processed.</P
><P
>The output of the above example would be something like:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    [1998/07/30 16:00:51, 0] file.c:function(128)
      This is a debug message.</PRE
></TD
></TR
></TABLE
></P
><P
>Each call to DEBUG() creates a new header *unless* the output produced
by the previous call to DEBUG() did not end with a '\n'. Output to the
debug file is passed through a formatting buffer which is flushed
every time a newline is encountered. If the buffer is not empty when
DEBUG() is called, the new input is simply appended.</P
><P
>...but that's really just a Kludge. It was put in place because
DEBUG() has been used to write partial lines. Here's a simple (dumb)
example of the kind of thing I'm talking about:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    DEBUG( 0, ("The test returned " ) );
    if( test() )
      DEBUG(0, ("True") );
    else
      DEBUG(0, ("False") );
    DEBUG(0, (".\n") );</PRE
></TD
></TR
></TABLE
></P
><P
>Without the format buffer, the output (assuming test() returned true)
would look like this:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    [1998/07/30 16:00:51, 0] file.c:function(256)
      The test returned
    [1998/07/30 16:00:51, 0] file.c:function(258)
      True
    [1998/07/30 16:00:51, 0] file.c:function(261)
      .</PRE
></TD
></TR
></TABLE
></P
><P
>Which isn't much use. The format buffer kludge fixes this problem.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN151">The DEBUGADD() Macro</H2
><P
>In addition to the kludgey solution to the broken line problem
described above, there is a clean solution. The DEBUGADD() macro never
generates a header. It will append new text to the current debug
message even if the format buffer is empty. The syntax of the
DEBUGADD() macro is the same as that of the DEBUG() macro.</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    DEBUG( 0, ("This is the first line.\n" ) );
    DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) );</PRE
></TD
></TR
></TABLE
></P
><P
>Produces</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    [1998/07/30 16:00:51, 0] file.c:function(512)
      This is the first line.
      This is the second line.
      This is the third line.</PRE
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN159">The DEBUGLVL() Macro</H2
><P
>One of the problems with the DEBUG() macro was that DEBUG() lines
tended to get a bit long. Consider this example from
nmbd_sendannounce.c:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>  DEBUG(3,("send_local_master_announcement: type %x for name %s on subnet %s for workgroup %s\n",
            type, global_myname, subrec-&#62;subnet_name, work-&#62;work_group));</PRE
></TD
></TR
></TABLE
></P
><P
>One solution to this is to break it down using DEBUG() and DEBUGADD(),
as follows:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>  DEBUG( 3, ( "send_local_master_announcement: " ) );
  DEBUGADD( 3, ( "type %x for name %s ", type, global_myname ) );
  DEBUGADD( 3, ( "on subnet %s ", subrec-&#62;subnet_name ) );
  DEBUGADD( 3, ( "for workgroup %s\n", work-&#62;work_group ) );</PRE
></TD
></TR
></TABLE
></P
><P
>A similar, but arguably nicer approach is to use the DEBUGLVL() macro.
This macro returns True if the message level is less than or equal to
the global DEBUGLEVEL value, so:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>  if( DEBUGLVL( 3 ) )
    {
    dbgtext( "send_local_master_announcement: " );
    dbgtext( "type %x for name %s ", type, global_myname );
    dbgtext( "on subnet %s ", subrec-&#62;subnet_name );
    dbgtext( "for workgroup %s\n", work-&#62;work_group );
    }</PRE
></TD
></TR
></TABLE
></P
><P
>(The dbgtext() function is explained below.)</P
><P
>There are a few advantages to this scheme:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>The test is performed only once.</P
></LI
><LI
><P
>You can allocate variables off of the stack that will only be used
within the DEBUGLVL() block.</P
></LI
><LI
><P
>Processing that is only relevant to debug output can be contained
within the DEBUGLVL() block.</P
></LI
></OL
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN179">New Functions</H2
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
NAME="AEN181">dbgtext()</H3
><P
>This function prints debug message text to the debug file (and
possibly to syslog) via the format buffer. The function uses a
variable argument list just like printf() or Debug1(). The
input is printed into a buffer using the vslprintf() function,
and then passed to format_debug_text().

If you use DEBUGLVL() you will probably print the body of the
message using dbgtext(). </P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN184">dbghdr()</H3
><P
>This is the function that writes a debug message header.
Headers are not processed via the format buffer. Also note that
if the format buffer is not empty, a call to dbghdr() will not
produce any output. See the comments in dbghdr() for more info.</P
><P
>It is not likely that this function will be called directly. It
is used by DEBUG() and DEBUGADD().</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN188">format_debug_text()</H3
><P
>This is a static function in debug.c. It stores the output text
for the body of the message in a buffer until it encounters a
newline. When the newline character is found, the buffer is
written to the debug file via the Debug1() function, and the
buffer is reset. This allows us to add the indentation at the
beginning of each line of the message body, and also ensures
that the output is written a line at a time (which cleans up
syslog output).</P
></DIV
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="CODINGSUGGESTIONS">Coding Suggestions</H1
><P
>So you want to add code to Samba ...</P
><P
>One of the daunting tasks facing a programmer attempting to write code for
Samba is understanding the various coding conventions used by those most
active in the project.  These conventions were mostly unwritten and helped
improve either the portability, stability or consistency of the code. This
document will attempt to document a few of the more important coding
practices used at this time on the Samba project.  The coding practices are
expected to change slightly over time, and even to grow as more is learned
about obscure portability considerations.  Two existing documents
<TT
CLASS="FILENAME"
>samba/source/internals.doc</TT
> and 
<TT
CLASS="FILENAME"
>samba/source/architecture.doc</TT
> provide
additional information.</P
><P
>The loosely related question of coding style is very personal and this
document does not attempt to address that subject, except to say that I
have observed that eight character tabs seem to be preferred in Samba
source.  If you are interested in the topic of coding style, two oft-quoted
documents are:</P
><P
><A
HREF="http://lxr.linux.no/source/Documentation/CodingStyle"
TARGET="_top"
>http://lxr.linux.no/source/Documentation/CodingStyle</A
></P
><P
><A
HREF="http://www.fsf.org/prep/standards_toc.html"
TARGET="_top"
>http://www.fsf.org/prep/standards_toc.html</A
></P
><P
>But note that coding style in Samba varies due to the many different
programmers who have contributed.</P
><P
>Following are some considerations you should use when adding new code to
Samba.  First and foremost remember that:</P
><P
>Portability is a primary consideration in adding function, as is network
compatability with de facto, existing, real world CIFS/SMB implementations.
There are lots of platforms that Samba builds on so use caution when adding
a call to a library function that is not invoked in existing Samba code.
Also note that there are many quite different SMB/CIFS clients that Samba
tries to support, not all of which follow the SNIA CIFS Technical Reference
(or the earlier Microsoft reference documents or the X/Open book on the SMB
Standard) perfectly.</P
><P
>Here are some other suggestions:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	use d_printf instead of printf for display text
	reason: enable auto-substitution of translated language text </P
></LI
><LI
><P
>	use SAFE_FREE instead of free
	reason: reduce traps due to null pointers</P
></LI
><LI
><P
>	don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros
	reason: not POSIX</P
></LI
><LI
><P
>	don't use strcpy and strlen (use safe_* equivalents)
	reason: to avoid traps due to buffer overruns</P
></LI
><LI
><P
>	don't use getopt_long, use popt functions instead
	reason: portability</P
></LI
><LI
><P
>	explicitly add const qualifiers on parm passing in functions where parm
	is input only (somewhat controversial but const can be #defined away)</P
></LI
><LI
><P
>	when passing a va_list as an arg, or assigning one to another
	please use the VA_COPY() macro
	reason: on some platforms, va_list is a struct that must be 
	initialized in each function...can SEGV if you don't.</P
></LI
><LI
><P
>	discourage use of threads
	reason: portability (also see architecture.doc)</P
></LI
><LI
><P
>	don't explicitly include new header files in C files - new h files 
	should be included by adding them once to includes.h
	reason: consistency</P
></LI
><LI
><P
>	don't explicitly extern functions (they are autogenerated by 
	"make proto" into proto.h)
	reason: consistency</P
></LI
><LI
><P
>	use endian safe macros when unpacking SMBs (see byteorder.h and
	internals.doc)
	reason: not everyone uses Intel</P
></LI
><LI
><P
>	Note Unicode implications of charset handling (see internals.doc).  See
	pull_*  and push_* and convert_string functions.
	reason: Internationalization</P
></LI
><LI
><P
>	Don't assume English only
	reason: See above</P
></LI
><LI
><P
>	Try to avoid using in/out parameters (functions that return data which
	overwrites input parameters)
	reason: Can cause stability problems</P
></LI
><LI
><P
>	Ensure copyright notices are correct, don't append Tridge's name to code
	that he didn't write.  If you did not write the code, make sure that it
	can coexist with the rest of the Samba GPLed code.</P
></LI
><LI
><P
>	Consider usage of DATA_BLOBs for length specified byte-data.
	reason: stability</P
></LI
><LI
><P
>	Take advantage of tdbs for database like function
	reason: consistency</P
></LI
><LI
><P
>	Don't access the SAM_ACCOUNT structure directly, they should be accessed
	via pdb_get...() and pdb_set...() functions.
	reason: stability, consistency</P
></LI
><LI
><P
>	Don't check a password directly against the passdb, always use the
	check_password() interface.
	reason: long term pluggability</P
></LI
><LI
><P
>	Try to use asprintf rather than pstrings and fstrings where possible</P
></LI
><LI
><P
>	Use normal C comments / * instead of C++ comments // like
	this.  Although the C++ comment format is part of the C99
	standard, some older vendor C compilers do not accept it.</P
></LI
><LI
><P
>	Try to write documentation for API functions and structures
	explaining the point of the code, the way it should be used, and
	any special conditions or results.  Mark these with a double-star
	comment start / ** so that they can be picked up by Doxygen, as in
	this file.</P
></LI
><LI
><P
>	Keep the scope narrow. This means making functions/variables
	static whenever possible. We don't want our namespace
	polluted. Each module should have a minimal number of externally
	visible functions or variables.</P
></LI
><LI
><P
>	Use function pointers to keep knowledge about particular pieces of
	code isolated in one place. We don't want a particular piece of
	functionality to be spread out across lots of places - that makes
	for fragile, hand to maintain code. Instead, design an interface
	and use tables containing function pointers to implement specific
	functionality. This is particularly important for command
	interpreters. </P
></LI
><LI
><P
>	Think carefully about what it will be like for someone else to add
	to and maintain your code. If it would be hard for someone else to
	maintain then do it another way. </P
></LI
></OL
><P
>The suggestions above are simply that, suggestions, but the information may
help in reducing the routine rework done on new code.  The preceeding list
is expected to change routinely as new support routines and macros are
added.</P
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="INTERNALS">Samba Internals</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN284">Character Handling</H2
><P
>This section describes character set handling in Samba, as implemented in
Samba 3.0 and above</P
><P
>In the past Samba had very ad-hoc character set handling. Scattered
throughout the code were numerous calls which converted particular
strings to/from DOS codepages. The problem is that there was no way of
telling if a particular char* is in dos codepage or unix
codepage. This led to a nightmare of code that tried to cope with
particular cases without handlingt the general case.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN288">The new functions</H2
><P
>The new system works like this:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	all char* strings inside Samba are "unix" strings. These are
	multi-byte strings that are in the charset defined by the "unix
	charset" option in smb.conf. </P
></LI
><LI
><P
>	there is no single fixed character set for unix strings, but any
	character set that is used does need the following properties:
	</P
><P
></P
><OL
TYPE="a"
><LI
><P
>		must not contain NULLs except for termination
	</P
></LI
><LI
><P
>		must be 7-bit compatible with C strings, so that a constant
		string or character in C will be byte-for-byte identical to the
		equivalent string in the chosen character set. 
	</P
></LI
><LI
><P
>		when you uppercase or lowercase a string it does not become
		longer than the original string
	</P
></LI
><LI
><P
>		must be able to correctly hold all characters that your client
		will throw at it
	</P
></LI
></OL
><P
>	For example, UTF-8 is fine, and most multi-byte asian character sets
	are fine, but UCS2 could not be used for unix strings as they
	contain nulls.
	</P
></LI
><LI
><P
>	when you need to put a string into a buffer that will be sent on the
	wire, or you need a string in a character set format that is
	compatible with the clients character set then you need to use a
	pull_ or push_ function. The pull_ functions pull a string from a
	wire buffer into a (multi-byte) unix string. The push_ functions
	push a string out to a wire buffer. </P
></LI
><LI
><P
>	the two main pull_ and push_ functions you need to understand are
	pull_string and push_string. These functions take a base pointer
	that should point at the start of the SMB packet that the string is
	in. The functions will check the flags field in this packet to
	automatically determine if the packet is marked as a unicode packet,
	and they will choose whether to use unicode for this string based on
	that flag. You may also force this decision using the STR_UNICODE or
	STR_ASCII flags. For use in smbd/ and libsmb/ there are wrapper
	functions clistr_ and srvstr_ that call the pull_/push_ functions
	with the appropriate first argument.
	</P
><P
>	You may also call the pull_ascii/pull_ucs2 or push_ascii/push_ucs2
	functions if you know that a particular string is ascii or
	unicode. There are also a number of other convenience functions in
	charcnv.c that call the pull_/push_ functions with particularly
	common arguments, such as pull_ascii_pstring()
	</P
></LI
><LI
><P
>	The biggest thing to remember is that internal (unix) strings in Samba
	may now contain multi-byte characters. This means you cannot assume
	that characters are always 1 byte long. Often this means that you will
	have to convert strings to ucs2 and back again in order to do some
	(seemingly) simple task. For examples of how to do this see functions
	like strchr_m(). I know this is very slow, and we will eventually
	speed it up but right now we want this stuff correct not fast.</P
></LI
><LI
><P
>	all lp_ functions now return unix strings. The magic "DOS" flag on
	parameters is gone.</P
></LI
><LI
><P
>	all vfs functions take unix strings. Don't convert when passing to them</P
></LI
></OL
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN317">Macros in byteorder.h</H2
><P
>This section describes the macros defined in byteorder.h.  These macros 
are used extensively in the Samba code.</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN320">CVAL(buf,pos)</H3
><P
>returns the byte at offset pos within buffer buf as an unsigned character.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN323">PVAL(buf,pos)</H3
><P
>returns the value of CVAL(buf,pos) cast to type unsigned integer.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN326">SCVAL(buf,pos,val)</H3
><P
>sets the byte at offset pos within buffer buf to value val.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN329">SVAL(buf,pos)</H3
><P
>	returns the value of the unsigned short (16 bit) little-endian integer at 
	offset pos within buffer buf.  An integer of this type is sometimes
	refered to as "USHORT".</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN332">IVAL(buf,pos)</H3
><P
>returns the value of the unsigned 32 bit little-endian integer at offset 
pos within buffer buf.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN335">SVALS(buf,pos)</H3
><P
>returns the value of the signed short (16 bit) little-endian integer at 
offset pos within buffer buf.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN338">IVALS(buf,pos)</H3
><P
>returns the value of the signed 32 bit little-endian integer at offset pos
within buffer buf.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN341">SSVAL(buf,pos,val)</H3
><P
>sets the unsigned short (16 bit) little-endian integer at offset pos within 
buffer buf to value val.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN344">SIVAL(buf,pos,val)</H3
><P
>sets the unsigned 32 bit little-endian integer at offset pos within buffer 
buf to the value val.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN347">SSVALS(buf,pos,val)</H3
><P
>sets the short (16 bit) signed little-endian integer at offset pos within 
buffer buf to the value val.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN350">SIVALS(buf,pos,val)</H3
><P
>sets the signed 32 bit little-endian integer at offset pos withing buffer
buf to the value val.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN353">RSVAL(buf,pos)</H3
><P
>returns the value of the unsigned short (16 bit) big-endian integer at 
offset pos within buffer buf.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN356">RIVAL(buf,pos)</H3
><P
>returns the value of the unsigned 32 bit big-endian integer at offset 
pos within buffer buf.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN359">RSSVAL(buf,pos,val)</H3
><P
>sets the value of the unsigned short (16 bit) big-endian integer at 
offset pos within buffer buf to value val.
refered to as "USHORT".</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN362">RSIVAL(buf,pos,val)</H3
><P
>sets the value of the unsigned 32 bit big-endian integer at offset 
pos within buffer buf to value val.</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN365">LAN Manager Samba API</H2
><P
>This section describes the functions need to make a LAN Manager RPC call.
This information had been obtained by examining the Samba code and the LAN
Manager 2.0 API documentation.  It should not be considered entirely
reliable.</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt, 
	char *param, char *data, char **rparam, char **rdata);</PRE
></TD
></TR
></TABLE
></P
><P
>This function is defined in client.c.  It uses an SMB transaction to call a
remote api.</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN371">Parameters</H3
><P
>The parameters are as follows:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	prcnt: the number of bytes of parameters begin sent.</P
></LI
><LI
><P
>	drcnt:   the number of bytes of data begin sent.</P
></LI
><LI
><P
>	mprcnt:  the maximum number of bytes of parameters which should be returned</P
></LI
><LI
><P
>	mdrcnt:  the maximum number of bytes of data which should be returned</P
></LI
><LI
><P
>	param:   a pointer to the parameters to be sent.</P
></LI
><LI
><P
>	data:    a pointer to the data to be sent.</P
></LI
><LI
><P
>	rparam:  a pointer to a pointer which will be set to point to the returned
	paramters.  The caller of call_api() must deallocate this memory.</P
></LI
><LI
><P
>	rdata:   a pointer to a pointer which will be set to point to the returned 
	data.  The caller of call_api() must deallocate this memory.</P
></LI
></OL
><P
>These are the parameters which you ought to send, in the order of their
appearance in the parameter block:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>An unsigned 16 bit integer API number.  You should set this value with
SSVAL().  I do not know where these numbers are described.</P
></LI
><LI
><P
>An ASCIIZ string describing the parameters to the API function as defined
in the LAN Manager documentation.  The first parameter, which is the server
name, is ommited.  This string is based uppon the API function as described
in the manual, not the data which is actually passed.</P
></LI
><LI
><P
>An ASCIIZ string describing the data structure which ought to be returned.</P
></LI
><LI
><P
>Any parameters which appear in the function call, as defined in the LAN
Manager API documentation, after the "Server" and up to and including the
"uLevel" parameters.</P
></LI
><LI
><P
>An unsigned 16 bit integer which gives the size in bytes of the buffer we
will use to receive the returned array of data structures.  Presumably this
should be the same as mdrcnt.  This value should be set with SSVAL().</P
></LI
><LI
><P
>An ASCIIZ string describing substructures which should be returned.  If no 
substructures apply, this string is of zero length.</P
></LI
></OL
><P
>The code in client.c always calls call_api() with no data.  It is unclear
when a non-zero length data buffer would be sent.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN406">Return value</H3
><P
>The returned parameters (pointed to by rparam), in their order of appearance
are:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>An unsigned 16 bit integer which contains the API function's return code. 
This value should be read with SVAL().</P
></LI
><LI
><P
>An adjustment which tells the amount by which pointers in the returned
data should be adjusted.  This value should be read with SVAL().  Basically, 
the address of the start of the returned data buffer should have the returned
pointer value added to it and then have this value subtracted from it in
order to obtain the currect offset into the returned data buffer.</P
></LI
><LI
><P
>A count of the number of elements in the array of structures returned. 
It is also possible that this may sometimes be the number of bytes returned.</P
></LI
></OL
><P
>When call_api() returns, rparam points to the returned parameters.  The
first if these is the result code.  It will be zero if the API call
suceeded.  This value by be read with "SVAL(rparam,0)".</P
><P
>The second parameter may be read as "SVAL(rparam,2)".  It is a 16 bit offset
which indicates what the base address of the returned data buffer was when
it was built on the server.  It should be used to correct pointer before
use.</P
><P
>The returned data buffer contains the array of returned data structures. 
Note that all pointers must be adjusted before use.  The function
fix_char_ptr() in client.c can be used for this purpose.</P
><P
>The third parameter (which may be read as "SVAL(rparam,4)") has something to
do with indicating the amount of data returned or possibly the amount of
data which can be returned if enough buffer space is allowed.</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN420">Code character table</H2
><P
>Certain data structures are described by means of ASCIIz strings containing
code characters.  These are the code characters:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>W	a type byte little-endian unsigned integer</P
></LI
><LI
><P
>N	a count of substructures which follow</P
></LI
><LI
><P
>D	a four byte little-endian unsigned integer</P
></LI
><LI
><P
>B	a byte (with optional count expressed as trailing ASCII digits)</P
></LI
><LI
><P
>z	a four byte offset to a NULL terminated string</P
></LI
><LI
><P
>l	a four byte offset to non-string user data</P
></LI
><LI
><P
>b	an offset to data (with count expressed as trailing ASCII digits)</P
></LI
><LI
><P
>r	pointer to returned data buffer???</P
></LI
><LI
><P
>L	length in bytes of returned data buffer???</P
></LI
><LI
><P
>h	number of bytes of information available???</P
></LI
></OL
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="PARSING">The smb.conf file</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN451">Lexical Analysis</H2
><P
>Basically, the file is processed on a line by line basis.  There are
four types of lines that are recognized by the lexical analyzer
(params.c):</P
><P
></P
><OL
TYPE="1"
><LI
><P
>Blank lines - Lines containing only whitespace.</P
></LI
><LI
><P
>Comment lines - Lines beginning with either a semi-colon or a
pound sign (';' or '#').</P
></LI
><LI
><P
>Section header lines - Lines beginning with an open square bracket ('[').</P
></LI
><LI
><P
>Parameter lines - Lines beginning with any other character.
(The default line type.)</P
></LI
></OL
><P
>The first two are handled exclusively by the lexical analyzer, which
ignores them.  The latter two line types are scanned for</P
><P
></P
><OL
TYPE="1"
><LI
><P
>  - Section names</P
></LI
><LI
><P
>  - Parameter names</P
></LI
><LI
><P
>  - Parameter values</P
></LI
></OL
><P
>These are the only tokens passed to the parameter loader
(loadparm.c).  Parameter names and values are divided from one
another by an equal sign: '='.</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN472">Handling of Whitespace</H3
><P
>Whitespace is defined as all characters recognized by the isspace()
function (see ctype(3C)) except for the newline character ('\n')
The newline is excluded because it identifies the end of the line.</P
><P
></P
><OL
TYPE="1"
><LI
><P
>The lexical analyzer scans past white space at the beginning of a line.</P
></LI
><LI
><P
>Section and parameter names may contain internal white space.  All
whitespace within a name is compressed to a single space character. </P
></LI
><LI
><P
>Internal whitespace within a parameter value is kept verbatim with 
the exception of carriage return characters ('\r'), all of which
are removed.</P
></LI
><LI
><P
>Leading and trailing whitespace is removed from names and values.</P
></LI
></OL
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN484">Handling of Line Continuation</H3
><P
>Long section header and parameter lines may be extended across
multiple lines by use of the backslash character ('\\').  Line
continuation is ignored for blank and comment lines.</P
><P
>If the last (non-whitespace) character within a section header or on
a parameter line is a backslash, then the next line will be
(logically) concatonated with the current line by the lexical
analyzer.  For example:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	param name = parameter value string \
	with line continuation.</PRE
></TD
></TR
></TABLE
></P
><P
>Would be read as</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>    param name = parameter value string     with line continuation.</PRE
></TD
></TR
></TABLE
></P
><P
>Note that there are five spaces following the word 'string',
representing the one space between 'string' and '\\' in the top
line, plus the four preceeding the word 'with' in the second line.
(Yes, I'm counting the indentation.)</P
><P
>Line continuation characters are ignored on blank lines and at the end
of comments.  They are *only* recognized within section and parameter
lines.</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN495">Line Continuation Quirks</H3
><P
>Note the following example:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	param name = parameter value string \
    \
    with line continuation.</PRE
></TD
></TR
></TABLE
></P
><P
>The middle line is *not* parsed as a blank line because it is first
concatonated with the top line.  The result is</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>param name = parameter value string         with line continuation.</PRE
></TD
></TR
></TABLE
></P
><P
>The same is true for comment lines.</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	param name = parameter value string \
	; comment \
    with a comment.</PRE
></TD
></TR
></TABLE
></P
><P
>This becomes:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>param name = parameter value string     ; comment     with a comment.</PRE
></TD
></TR
></TABLE
></P
><P
>On a section header line, the closing bracket (']') is considered a
terminating character, and the rest of the line is ignored.  The lines</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	[ section   name ] garbage \
    param  name  = value</PRE
></TD
></TR
></TABLE
></P
><P
>are read as</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	[section name]
    param name = value</PRE
></TD
></TR
></TABLE
></P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN515">Syntax</H2
><P
>The syntax of the smb.conf file is as follows:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>  &#60;file&#62;            :==  { &#60;section&#62; } EOF
  &#60;section&#62;         :==  &#60;section header&#62; { &#60;parameter line&#62; }
  &#60;section header&#62;  :==  '[' NAME ']'
  &#60;parameter line&#62;  :==  NAME '=' VALUE NL</PRE
></TD
></TR
></TABLE
></P
><P
>Basically, this means that</P
><P
></P
><OL
TYPE="1"
><LI
><P
>	a file is made up of zero or more sections, and is terminated by
	an EOF (we knew that).</P
></LI
><LI
><P
>	A section is made up of a section header followed by zero or more
	parameter lines.</P
></LI
><LI
><P
>	A section header is identified by an opening bracket and
	terminated by the closing bracket.  The enclosed NAME identifies
	the section.</P
></LI
><LI
><P
>	A parameter line is divided into a NAME and a VALUE.  The *first*
	equal sign on the line separates the NAME from the VALUE.  The
	VALUE is terminated by a newline character (NL = '\n').</P
></LI
></OL
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN530">About params.c</H3
><P
>The parsing of the config file is a bit unusual if you are used to
lex, yacc, bison, etc.  Both lexical analysis (scanning) and parsing
are performed by params.c.  Values are loaded via callbacks to
loadparm.c.</P
></DIV
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="UNIX-SMB">NetBIOS in a Unix World</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN540">Introduction</H2
><P
>This is a short document that describes some of the issues that
confront a SMB implementation on unix, and how Samba copes with
them. They may help people who are looking at unix&#60;-&#62;PC
interoperability.</P
><P
>It was written to help out a person who was writing a paper on unix to
PC connectivity.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN544">Usernames</H2
><P
>The SMB protocol has only a loose username concept. Early SMB
protocols (such as CORE and COREPLUS) have no username concept at
all. Even in later protocols clients often attempt operations
(particularly printer operations) without first validating a username
on the server.</P
><P
>Unix security is based around username/password pairs. A unix box
should not allow clients to do any substantive operation without some
sort of validation. </P
><P
>The problem mostly manifests itself when the unix server is in "share
level" security mode. This is the default mode as the alternative
"user level" security mode usually forces a client to connect to the
server as the same user for each connected share, which is
inconvenient in many sites.</P
><P
>In "share level" security the client normally gives a username in the
"session setup" protocol, but does not supply an accompanying
password. The client then connects to resources using the "tree
connect" protocol, and supplies a password. The problem is that the
user on the PC types the username and the password in different
contexts, unaware that they need to go together to give access to the
server. The username is normally the one the user typed in when they
"logged onto" the PC (this assumes Windows for Workgroups). The
password is the one they chose when connecting to the disk or printer.</P
><P
>The user often chooses a totally different username for their login as
for the drive connection. Often they also want to access different
drives as different usernames. The unix server needs some way of
divining the correct username to combine with each password.</P
><P
>Samba tries to avoid this problem using several methods. These succeed
in the vast majority of cases. The methods include username maps, the
service%user syntax, the saving of session setup usernames for later
validation and the derivation of the username from the service name
(either directly or via the user= option).</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN552">File Ownership</H2
><P
>The commonly used SMB protocols have no way of saying "you can't do
that because you don't own the file". They have, in fact, no concept
of file ownership at all.</P
><P
>This brings up all sorts of interesting problems. For example, when
you copy a file to a unix drive, and the file is world writeable but
owned by another user the file will transfer correctly but will
receive the wrong date. This is because the utime() call under unix
only succeeds for the owner of the file, or root, even if the file is
world writeable. For security reasons Samba does all file operations
as the validated user, not root, so the utime() fails. This can stuff
up shared development diectories as programs like "make" will not get
file time comparisons right.</P
><P
>There are several possible solutions to this problem, including
username mapping, and forcing a specific username for particular
shares.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN557">Passwords</H2
><P
>Many SMB clients uppercase passwords before sending them. I have no
idea why they do this. Interestingly WfWg uppercases the password only
if the server is running a protocol greater than COREPLUS, so
obviously it isn't just the data entry routines that are to blame.</P
><P
>Unix passwords are case sensitive. So if users use mixed case
passwords they are in trouble.</P
><P
>Samba can try to cope with this by either using the "password level"
option which causes Samba to try the offered password with up to the
specified number of case changes, or by using the "password server"
option which allows Samba to do its validation via another machine
(typically a WinNT server).</P
><P
>Samba supports the password encryption method used by SMB
clients. Note that the use of password encryption in Microsoft
networking leads to password hashes that are "plain text equivalent".
This means that it is *VERY* important to ensure that the Samba
smbpasswd file containing these password hashes is only readable
by the root user. See the documentation ENCRYPTION.txt for more
details.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN563">Locking</H2
><P
>The locking calls available under a DOS/Windows environment are much
richer than those available in unix. This means a unix server (like
Samba) choosing to use the standard fcntl() based unix locking calls
to implement SMB locking has to improvise a bit.</P
><P
>One major problem is that dos locks can be in a 32 bit (unsigned)
range. Unix locking calls are 32 bits, but are signed, giving only a 31
bit range. Unfortunately OLE2 clients use the top bit to select a
locking range used for OLE semaphores.</P
><P
>To work around this problem Samba compresses the 32 bit range into 31
bits by appropriate bit shifting. This seems to work but is not
ideal. In a future version a separate SMB lockd may be added to cope
with the problem.</P
><P
>It also doesn't help that many unix lockd daemons are very buggy and
crash at the slightest provocation. They normally go mostly unused in
a unix environment because few unix programs use byte range
locking. The stress of huge numbers of lock requests from dos/windows
clients can kill the daemon on some systems.</P
><P
>The second major problem is the "opportunistic locking" requested by
some clients. If a client requests opportunistic locking then it is
asking the server to notify it if anyone else tries to do something on
the same file, at which time the client will say if it is willing to
give up its lock. Unix has no simple way of implementing
opportunistic locking, and currently Samba has no support for it.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN570">Deny Modes</H2
><P
>When a SMB client opens a file it asks for a particular "deny mode" to
be placed on the file. These modes (DENY_NONE, DENY_READ, DENY_WRITE,
DENY_ALL, DENY_FCB and DENY_DOS) specify what actions should be
allowed by anyone else who tries to use the file at the same time. If
DENY_READ is placed on the file, for example, then any attempt to open
the file for reading should fail.</P
><P
>Unix has no equivalent notion. To implement this Samba uses either lock
files based on the files inode and placed in a separate lock
directory or a shared memory implementation. The lock file method 
is clumsy and consumes processing and file resources,
the shared memory implementation is vastly prefered and is turned on
by default for those systems that support it.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN574">Trapdoor UIDs</H2
><P
>A SMB session can run with several uids on the one socket. This
happens when a user connects to two shares with different
usernames. To cope with this the unix server needs to switch uids
within the one process. On some unixes (such as SCO) this is not
possible. This means that on those unixes the client is restricted to
a single uid.</P
><P
>Note that you can also get the "trapdoor uid" message for other
reasons. Please see the FAQ for details.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN578">Port numbers</H2
><P
>There is a convention that clients on sockets use high "unprivilaged"
port numbers (&#62;1000) and connect to servers on low "privilaged" port
numbers. This is enforced in Unix as non-root users can't open a
socket for listening on port numbers less than 1000.</P
><P
>Most PC based SMB clients (such as WfWg and WinNT) don't follow this
convention completely. The main culprit is the netbios nameserving on
udp port 137. Name query requests come from a source port of 137. This
is a problem when you combine it with the common firewalling technique
of not allowing incoming packets on low port numbers. This means that
these clients can't query a netbios nameserver on the other side of a
low port based firewall.</P
><P
>The problem is more severe with netbios node status queries. I've
found that WfWg, Win95 and WinNT3.5 all respond to netbios node status
queries on port 137 no matter what the source port was in the
request. This works between machines that are both using port 137, but
it means it's not possible for a unix user to do a node status request
to any of these OSes unless they are running as root. The answer comes
back, but it goes to port 137 which the unix user can't listen
on. Interestingly WinNT3.1 got this right - it sends node status
responses back to the source port in the request.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN583">Protocol Complexity</H2
><P
>There are many "protocol levels" in the SMB protocol. It seems that
each time new functionality was added to a Microsoft operating system,
they added the equivalent functions in a new protocol level of the SMB
protocol to "externalise" the new capabilities.</P
><P
>This means the protocol is very "rich", offering many ways of doing
each file operation. This means SMB servers need to be complex and
large. It also means it is very difficult to make them bug free. It is
not just Samba that suffers from this problem, other servers such as
WinNT don't support every variation of every call and it has almost
certainly been a headache for MS developers to support the myriad of
SMB calls that are available.</P
><P
>There are about 65 "top level" operations in the SMB protocol (things
like SMBread and SMBwrite). Some of these include hundreds of
sub-functions (SMBtrans has at least 120 sub-functions, like
DosPrintQAdd and NetSessionEnum). All of them take several options
that can change the way they work. Many take dozens of possible
"information levels" that change the structures that need to be
returned. Samba supports all but 2 of the "top level" functions. It
supports only 8 (so far) of the SMBtrans sub-functions. Even NT
doesn't support them all.</P
><P
>Samba currently supports up to the "NT LM 0.12" protocol, which is the
one preferred by Win95 and WinNT3.5. Luckily this protocol level has a
"capabilities" field which specifies which super-duper new-fangled
options the server suports. This helps to make the implementation of
this protocol level much easier.</P
><P
>There is also a problem with the SMB specications. SMB is a X/Open
spec, but the X/Open book is far from ideal, and fails to cover many
important issues, leaving much to the imagination. Microsoft recently
renamed the SMB protocol CIFS (Common Internet File System) and have 
published new specifications. These are far superior to the old 
X/Open documents but there are still undocumented calls and features. 
This specification is actively being worked on by a CIFS developers 
mailing list hosted by Microsft.</P
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="TRACING">Tracing samba system calls</H1
><P
>This file describes how to do a system call trace on Samba to work out
what its doing wrong. This is not for the faint of heart, but if you
are reading this then you are probably desperate.</P
><P
>Actually its not as bad as the the above makes it sound, just don't
expect the output to be very pretty :-)</P
><P
>Ok, down to business. One of the big advantages of unix systems is
that they nearly all come with a system trace utility that allows you
to monitor all system calls that a program is making. This is
extremely using for debugging and also helps when trying to work out
why something is slower than you expect. You can use system tracing
without any special compilation options. </P
><P
>The system trace utility is called different things on different
systems. On Linux systems its called strace. Under SunOS 4 its called
trace. Under SVR4 style systems (including solaris) its called
truss. Under many BSD systems its called ktrace. </P
><P
>The first thing you should do is read the man page for your native
system call tracer. In the discussion below I'll assume its called
strace as strace is the only portable system tracer (its available for
free for many unix types) and its also got some of the nicest
features.</P
><P
>Next, try using strace on some simple commands. For example, <B
CLASS="COMMAND"
>strace
ls</B
> or <B
CLASS="COMMAND"
>strace echo hello</B
>.</P
><P
> 
You'll notice that it produces a LOT of output. It is showing you the
arguments to every system call that the program makes and the
result. Very little happens in a program without a system call so you
get lots of output. You'll also find that it produces a lot of
"preamble" stuff showing the loading of shared libraries etc. Ignore
this (unless its going wrong!)</P
><P
>For example, the only line that really matters in the <B
CLASS="COMMAND"
>strace echo
hello</B
> output is:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>write(1, "hello\n", 6)                  = 6</PRE
></TD
></TR
></TABLE
></P
><P
>all the rest is just setting up to run the program.</P
><P
>Ok, now you're familiar with strace. To use it on Samba you need to
strace the running smbd daemon. The way I tend ot use it is to first
login from my Windows PC to the Samba server, then use smbstatus to
find which process ID that client is attached to, then as root I do
<B
CLASS="COMMAND"
>strace -p PID</B
> to attach to that process. I normally redirect the
stderr output from this command to a file for later perusal. For
example, if I'm using a csh style shell:</P
><P
><B
CLASS="COMMAND"
>strace -f -p 3872 &#62;&#38; strace.out</B
></P
><P
>or with a sh style shell:</P
><P
><B
CLASS="COMMAND"
>strace -f -p 3872 &#62; strace.out 2&#62;&#38;1</B
></P
><P
>Note the "-f" option. This is only available on some systems, and
allows you to trace not just the current process, but any children it
forks. This is great for finding printing problems caused by the
"print command" being wrong.</P
><P
>Once you are attached you then can do whatever it is on the client
that is causing problems and you will capture all the system calls
that smbd makes. </P
><P
>So how do you interpret the results? Generally I search through the
output for strings that I know will appear when the problem
happens. For example, if I am having touble with permissions on a file
I would search for that files name in the strace output and look at
the surrounding lines. Another trick is to match up file descriptor
numbers and "follow" what happens to an open file until it is closed.</P
><P
>Beyond this you will have to use your initiative. To give you an idea
of what you are looking for here is a piece of strace output that
shows that <TT
CLASS="FILENAME"
>/dev/null</TT
> is not world writeable, which
causes printing to fail with Samba:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>[pid 28268] open("/dev/null", O_RDWR)   = -1 EACCES (Permission denied)
[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied)</PRE
></TD
></TR
></TABLE
></P
><P
>The process is trying to first open <TT
CLASS="FILENAME"
>/dev/null</TT
> read-write 
then read-only. Both fail. This means <TT
CLASS="FILENAME"
>/dev/null</TT
> has 
incorrect permissions.</P
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="NTDOMAIN">NT Domain RPC's</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN651">Introduction</H2
><P
>This document contains information to provide an NT workstation with login
services, without the need for an NT server. It is the sgml version of <A
HREF="http://mailhost.cb1.com/~lkcl/cifsntdomain.txt"
TARGET="_top"
>http://mailhost.cb1.com/~lkcl/cifsntdomain.txt</A
>, controlled by Luke.</P
><P
>It should be possible to select a domain instead of a workgroup (in the NT
workstation's TCP/IP settings) and after the obligatory reboot, type in a
username, password, select a domain and successfully log in.  I would
appreciate any feedback on your experiences with this process, and any
comments, corrections and additions to this document.</P
><P
>The packets described here can be easily derived from (and are probably
better understood using) Netmon.exe.  You will need to use the version
of Netmon that matches your system, in order to correctly decode the
NETLOGON, lsarpc and srvsvc Transact pipes.  This document is derived from
NT Service Pack 1 and its corresponding version of Netmon.  It is intended
that an annotated packet trace be produced, which will likely be more
instructive than this document.</P
><P
>Also needed, to fully implement NT Domain Login Services, is the 
document describing the cryptographic part of the NT authentication.
This document is available from comp.protocols.smb; from the ntsecurity.net
digest and from the samba digest, amongst other sources.</P
><P
>A copy is available from:</P
><P
><A
HREF="http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935"
TARGET="_top"
>http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935</A
></P
><P
><A
HREF="http://mailhost.cb1.com/~lkcl/crypt.html"
TARGET="_top"
>http://mailhost.cb1.com/~lkcl/crypt.html</A
></P
><P
>A c-code implementation, provided by <A
HREF="mailto:linus@incolumitas.se"
TARGET="_top"
>Linus Nordberg</A
>
of this protocol is available from:</P
><P
><A
HREF="http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html"
TARGET="_top"
>http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html</A
></P
><P
><A
HREF="http://mailhost.cb1.com/~lkcl/crypt.txt"
TARGET="_top"
>http://mailhost.cb1.com/~lkcl/crypt.txt</A
></P
><P
>Also used to provide debugging information is the Check Build version of
NT workstation, and enabling full debugging in NETLOGON.  This is
achieved by setting the following REG_SZ registry key to 0x1ffffff:</P
><P
><TT
CLASS="FILENAME"
>HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters</TT
></P
><P
><I
CLASS="EMPHASIS"
>Incorrect direct editing of the registry can cause your
machine to fail. Then again, so can incorrect implementation of this 
protocol. See "Liability:" above.</I
></P
><P
>Bear in mind that each packet over-the-wire will have its origin in an
API call.  Therefore, there are likely to be structures, enumerations
and defines that are usefully documented elsewhere.</P
><P
>This document is by no means complete or authoritative.  Missing sections
include, but are not limited to:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>Mappings of RIDs to usernames (and vice-versa).</P
></LI
><LI
><P
>What a User ID is and what a Group ID is.</P
></LI
><LI
><P
>The exact meaning/definition of various magic constants or enumerations.</P
></LI
><LI
><P
>The reply error code and use of that error code when a
workstation becomes a member of a domain (to be described later).  
Failure to return this error code will make the workstation report 
that it is already a member of the domain.</P
></LI
><LI
><P
>the cryptographic side of the NetrServerPasswordSet command, 
which would allow the workstation to change its password.  This password is
used to generate the long-term session key.  [It is possible to reject this
command, and keep the default workstation password].</P
></LI
></OL
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN687">Sources</H3
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>cket Traces from Netmonitor (Service Pack 1 and above)</TD
></TR
><TR
><TD
>ul Ashton and Luke Leighton's other "NT Domain" doc.</TD
></TR
><TR
><TD
>FS documentation - cifs6.txt</TD
></TR
><TR
><TD
>FS documentation - cifsrap2.txt</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN694">Credits</H3
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>Paul Ashton: loads of work with Net Monitor; understanding the NT authentication system; reference implementation of the NT domain support on which this document is originally based.</TD
></TR
><TR
><TD
>Duncan Stansfield: low-level analysis of MSRPC Pipes.</TD
></TR
><TR
><TD
>Linus Nordberg: producing c-code from Paul's crypto spec.</TD
></TR
><TR
><TD
>Windows Sourcer development team</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN701">Notes and Structures</H2
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
NAME="AEN703">Notes</H3
><P
></P
><OL
TYPE="1"
><LI
><P
>In the SMB Transact pipes, some "Structures", described here, appear to be
4-byte aligned with the SMB header, at their start.  Exactly which
"Structures" need aligning is not precisely known or documented.</P
></LI
><LI
><P
>In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be
2-byte aligned with the start of the mailslot, at their start.</P
></LI
><LI
><P
>Domain SID is of the format S-revision-version-auth1-auth2...authN.
e.g S-1-5-123-456-789-123-456.  the 5 could be a sub-revision.</P
></LI
><LI
><P
>any undocumented buffer pointers must be non-zero if the string buffer it
refers to contains characters.  exactly what value they should be is unknown.
0x0000 0002 seems to do the trick to indicate that the buffer exists.  a
NULL buffer pointer indicates that the string buffer is of zero length.
If the buffer pointer is NULL, then it is suspected that the structure it
refers to is NOT put into (or taken out of) the SMB data stream.  This is
empirically derived from, for example, the LSA SAM Logon response packet,
where if the buffer pointer is NULL, the user information is not inserted
into the data stream.  Exactly what happens with an array of buffer pointers
is not known, although an educated guess can be made.</P
></LI
><LI
><P
>an array of structures (a container) appears to have a count and a pointer.
if the count is zero, the pointer is also zero.  no further data is put
into or taken out of the SMB data stream.  if the count is non-zero, then
the pointer is also non-zero.  immediately following the pointer is the
count again, followed by an array of container sub-structures.  the count
appears a third time after the last sub-structure.</P
></LI
></OL
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN716">Enumerations</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN718">MSRPC Header type</H4
><P
>command number in the msrpc packet header</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>MSRPC_Request:</DT
><DD
><P
>0x00</P
></DD
><DT
>MSRPC_Response:</DT
><DD
><P
>0x02</P
></DD
><DT
>MSRPC_Bind:</DT
><DD
><P
>0x0B</P
></DD
><DT
>MSRPC_BindAck:</DT
><DD
><P
>0x0C</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN738">MSRPC Packet info</H4
><P
>The meaning of these flags is undocumented</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>FirstFrag:</DT
><DD
><P
>0x01 </P
></DD
><DT
>LastFrag:</DT
><DD
><P
>0x02 </P
></DD
><DT
>NotaFrag:</DT
><DD
><P
>0x04  </P
></DD
><DT
>RecRespond:</DT
><DD
><P
>0x08  </P
></DD
><DT
>NoMultiplex:</DT
><DD
><P
>0x10  </P
></DD
><DT
>NotForIdemp:</DT
><DD
><P
>0x20  </P
></DD
><DT
>NotforBcast:</DT
><DD
><P
>0x40  </P
></DD
><DT
>NoUuid:</DT
><DD
><P
>0x80 </P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN774">Structures</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN776">VOID *</H4
><P
>sizeof VOID* is 32 bits.</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN779">char</H4
><P
>sizeof char is 8 bits.</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN782">UTIME</H4
><P
>UTIME is 32 bits, indicating time in seconds since 01jan1970.  documented in cifs6.txt (section 3.5 page, page 30).</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN785">NTTIME</H4
><P
>NTTIME is 64 bits.  documented in cifs6.txt (section 3.5 page, page 30).</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN788">DOM_SID (domain SID structure)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>num of sub-authorities in domain SID</P
></DD
><DT
>UINT8</DT
><DD
><P
>SID revision number</P
></DD
><DT
>UINT8</DT
><DD
><P
>num of sub-authorities in domain SID</P
></DD
><DT
>UINT8[6]</DT
><DD
><P
>6 bytes for domain SID - Identifier Authority.</P
></DD
><DT
>UINT16[n_subauths]</DT
><DD
><P
>domain SID sub-authorities</P
></DD
></DL
></DIV
><P
><I
CLASS="EMPHASIS"
>Note: the domain SID is documented elsewhere.</I
></P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN813">STR (string)</H4
><P
>STR (string) is a char[] : a null-terminated string of ascii characters.</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN816">UNIHDR (unicode string header)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16</DT
><DD
><P
>length of unicode string</P
></DD
><DT
>UINT16</DT
><DD
><P
>max length of unicode string</P
></DD
><DT
>UINT32</DT
><DD
><P
>4 - undocumented.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN831">UNIHDR2 (unicode string header plus buffer pointer)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UNIHDR</DT
><DD
><P
>unicode string header</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN842">UNISTR (unicode string)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16[]</DT
><DD
><P
>null-terminated string of unicode characters.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN849">NAME (length-indicated unicode string)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>length of unicode string</P
></DD
><DT
>UINT16[]</DT
><DD
><P
>null-terminated string of unicode characters.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN860">UNISTR2 (aligned unicode string)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT8[]</DT
><DD
><P
>padding to get unicode string 4-byte aligned with the start of the SMB header.</P
></DD
><DT
>UINT32</DT
><DD
><P
>max length of unicode string</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>length of unicode string</P
></DD
><DT
>UINT16[]</DT
><DD
><P
>string of uncode characters</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN883">OBJ_ATTR (object attributes)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>0x18 - length (in bytes) including the length field.</P
></DD
><DT
>VOID*</DT
><DD
><P
>0 - root directory (pointer)</P
></DD
><DT
>VOID*</DT
><DD
><P
>0 - object name (pointer)</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - attributes (undocumented)</P
></DD
><DT
>VOID*</DT
><DD
><P
>0 - security descriptior (pointer)</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - security quality of service</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN910">POL_HND (LSA policy handle)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>char[20]</DT
><DD
><P
>policy handle</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN917">DOM_SID2 (domain SID structure, SIDS stored in unicode)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>5 - SID type</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UNIHDR2</DT
><DD
><P
>domain SID unicode string header</P
></DD
><DT
>UNISTR</DT
><DD
><P
>domain SID unicode string</P
></DD
></DL
></DIV
><P
><I
CLASS="EMPHASIS"
>Note:	there is a conflict between the unicode string header and the unicode string itself as to which to use to indicate string length.  this will need to be resolved.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.</I
></P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN940">DOM_RID (domain RID structure)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>5 - well-known SID.  1 - user SID (see ShowACLs)</P
></DD
><DT
>UINT32</DT
><DD
><P
>5 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>domain RID </P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - domain index out of above reference domains</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN959">LOG_INFO (server, account, client structure)</H4
><P
><I
CLASS="EMPHASIS"
>Note:	logon server name starts with two '\' characters and is upper case.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon server unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>account name unicode string</P
></DD
><DT
>UINT16</DT
><DD
><P
>sec_chan - security channel type</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon client machine unicode string</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN986">CLNT_SRV (server, client names structure)</H4
><P
><I
CLASS="EMPHASIS"
>Note:	logon server name starts with two '\' characters and is upper case.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon server unicode string</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon client machine unicode string</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1007">CREDS (credentials + time stamp)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>char[8]</DT
><DD
><P
>credentials</P
></DD
><DT
>UTIME</DT
><DD
><P
>time stamp</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1018">CLNT_INFO2 (server, client structure, client credentials)</H4
><P
><I
CLASS="EMPHASIS"
>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will beused in subsequent credential checks.  the presumed intention is to
	maintain an authenticated request/response trail.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>CLNT_SRV</DT
><DD
><P
>client and server names</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>???? padding, for 4-byte alignment with SMB header.</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to client credentials.</P
></DD
><DT
>CREDS</DT
><DD
><P
>client-calculated credentials + client time</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1039">CLNT_INFO (server, account, client structure, client credentials)</H4
><P
><I
CLASS="EMPHASIS"
>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will be used in subsequent credential checks.  the presumed intention is to maintain an authenticated request/response trail.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>LOG_INFO</DT
><DD
><P
>logon account info</P
></DD
><DT
>CREDS</DT
><DD
><P
>client-calculated credentials + client time</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1052">ID_INFO_1 (id info structure, auth level 1)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>ptr_id_info_1</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>domain name unicode header</P
></DD
><DT
>UINT32</DT
><DD
><P
>param control</P
></DD
><DT
>UINT64</DT
><DD
><P
>logon ID</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>user name unicode header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>workgroup name unicode header</P
></DD
><DT
>char[16]</DT
><DD
><P
>arc4 LM OWF Password</P
></DD
><DT
>char[16]</DT
><DD
><P
>arc4 NT OWF Password</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>domain name unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>user name unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>workstation name unicode string</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1099">SAM_INFO (sam logon/logoff id info structure)</H4
><P
><I
CLASS="EMPHASIS"
>Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>CLNT_INFO2</DT
><DD
><P
>client identification/authentication info</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to return credentials.</P
></DD
><DT
>CRED</DT
><DD
><P
>return credentials - ignored.</P
></DD
><DT
>UINT16</DT
><DD
><P
>logon level</P
></DD
><DT
>UINT16</DT
><DD
><P
>switch value</P
></DD
></DL
></DIV
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>        switch (switch_value)
        case 1:
        {
            ID_INFO_1     id_info_1;
        }</PRE
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1126">GID (group id info)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>group id</P
></DD
><DT
>UINT32</DT
><DD
><P
>user attributes (only used by NT 3.1 and 3.51)</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1137">DOM_REF (domain reference info)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer.</P
></DD
><DT
>UINT32</DT
><DD
><P
>num referenced domains?</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain name buffer pointer.</P
></DD
><DT
>UINT32</DT
><DD
><P
>32 - max number of entries</P
></DD
><DT
>UINT32</DT
><DD
><P
>4 - num referenced domains?</P
></DD
><DT
>UNIHDR2</DT
><DD
><P
>domain name unicode string header</P
></DD
><DT
>UNIHDR2[num_ref_doms-1]</DT
><DD
><P
>referenced domain unicode string headers</P
></DD
><DT
>UNISTR</DT
><DD
><P
>domain name unicode string</P
></DD
><DT
>DOM_SID[num_ref_doms]</DT
><DD
><P
>referenced domain SIDs</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1176">DOM_INFO (domain info, levels 3 and 5 are the same))</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT8[]</DT
><DD
><P
>??? padding to get 4-byte alignment with start of SMB header</P
></DD
><DT
>UINT16</DT
><DD
><P
>domain name string length * 2</P
></DD
><DT
>UINT16</DT
><DD
><P
>domain name string length * 2</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain name string buffer pointer</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain SID string buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>domain name (unicode string)</P
></DD
><DT
>DOM_SID</DT
><DD
><P
>domain SID</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1207">USER_INFO (user logon info)</H4
><P
><I
CLASS="EMPHASIS"
>Note: it would be nice to know what the 16 byte user session key is for.</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>NTTIME</DT
><DD
><P
>logon time</P
></DD
><DT
>NTTIME</DT
><DD
><P
>logoff time</P
></DD
><DT
>NTTIME</DT
><DD
><P
>kickoff time</P
></DD
><DT
>NTTIME</DT
><DD
><P
>password last set time</P
></DD
><DT
>NTTIME</DT
><DD
><P
>password can change time</P
></DD
><DT
>NTTIME</DT
><DD
><P
>password must change time</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>username unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>user's full name unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>logon script unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>profile path unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>home directory unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>home directory drive unicode string header</P
></DD
><DT
>UINT16</DT
><DD
><P
>logon count</P
></DD
><DT
>UINT16</DT
><DD
><P
>bad password count</P
></DD
><DT
>UINT32</DT
><DD
><P
>User ID</P
></DD
><DT
>UINT32</DT
><DD
><P
>Group ID</P
></DD
><DT
>UINT32</DT
><DD
><P
>num groups</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer to groups.</P
></DD
><DT
>UINT32</DT
><DD
><P
>user flags</P
></DD
><DT
>char[16]</DT
><DD
><P
>user session key</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>logon server unicode string header</P
></DD
><DT
>UNIHDR</DT
><DD
><P
>logon domain unicode string header</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented logon domain id pointer</P
></DD
><DT
>char[40]</DT
><DD
><P
>40 undocumented padding bytes.  future expansion?</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - num_other_sids?</P
></DD
><DT
>VOID*</DT
><DD
><P
>NULL - undocumented pointer to other domain SIDs.</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>username unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>user's full name unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon script unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>profile path unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>home directory unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>home directory drive unicode string</P
></DD
><DT
>UINT32</DT
><DD
><P
>num groups</P
></DD
><DT
>GID[num_groups]</DT
><DD
><P
>group info</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon server unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon domain unicode string</P
></DD
><DT
>DOM_SID</DT
><DD
><P
>domain SID</P
></DD
><DT
>DOM_SID[num_sids]</DT
><DD
><P
>other domain SIDs?</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1364">SH_INFO_1_PTR (pointers to level 1 share info strings)</H4
><P
><I
CLASS="EMPHASIS"
>Note:	see cifsrap2.txt section5, page 10.</I
></P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>0 for shi1_type indicates a  Disk.</TD
></TR
><TR
><TD
>1 for shi1_type indicates a  Print Queue.</TD
></TR
><TR
><TD
>2 for shi1_type indicates a  Device.</TD
></TR
><TR
><TD
>3 for shi1_type indicates an IPC pipe.</TD
></TR
><TR
><TD
>0x8000 0000 (top bit set in shi1_type) indicates a hidden share.</TD
></TR
></TBODY
></TABLE
><P
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>shi1_netname - pointer to net name</P
></DD
><DT
>UINT32</DT
><DD
><P
>shi1_type    - type of share.  0 - undocumented.</P
></DD
><DT
>VOID*</DT
><DD
><P
>shi1_remark  - pointer to comment.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1387">SH_INFO_1_STR (level 1 share info strings)</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UNISTR2</DT
><DD
><P
>shi1_netname - unicode string of net name</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>shi1_remark  - unicode string of comment.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1398">SHARE_INFO_1_CTR</H4
><P
>share container with 0 entries:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>0 - EntriesRead</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - Buffer</P
></DD
></DL
></DIV
><P
>share container with &#62; 0 entries:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>EntriesRead</P
></DD
><DT
>UINT32</DT
><DD
><P
>non-zero - Buffer</P
></DD
><DT
>UINT32</DT
><DD
><P
>EntriesRead</P
></DD
><DT
>SH_INFO_1_PTR[EntriesRead]</DT
><DD
><P
>share entry pointers</P
></DD
><DT
>SH_INFO_1_STR[EntriesRead]</DT
><DD
><P
>share entry strings</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to get unicode string 4-byte aligned with start of the SMB header.</P
></DD
><DT
>UINT32</DT
><DD
><P
>EntriesRead</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - padding</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1444">SERVER_INFO_101</H4
><P
><I
CLASS="EMPHASIS"
>Note:	see cifs6.txt section 6.4 - the fields described therein will be of assistance here.  for example, the type listed below is the 	same as fServerType, which is described in 6.4.1. </I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>SV_TYPE_WORKSTATION</DT
><DD
><P
>0x00000001  All workstations</P
></DD
><DT
>SV_TYPE_SERVER</DT
><DD
><P
>0x00000002  All servers</P
></DD
><DT
>SV_TYPE_SQLSERVER</DT
><DD
><P
>0x00000004  Any server running with SQL server</P
></DD
><DT
>SV_TYPE_DOMAIN_CTRL</DT
><DD
><P
>0x00000008  Primary domain controller</P
></DD
><DT
>SV_TYPE_DOMAIN_BAKCTRL</DT
><DD
><P
>0x00000010  Backup domain controller</P
></DD
><DT
>SV_TYPE_TIME_SOURCE</DT
><DD
><P
>0x00000020  Server running the timesource service</P
></DD
><DT
>SV_TYPE_AFP</DT
><DD
><P
>0x00000040  Apple File Protocol servers</P
></DD
><DT
>SV_TYPE_NOVELL</DT
><DD
><P
>0x00000080  Novell servers</P
></DD
><DT
>SV_TYPE_DOMAIN_MEMBER</DT
><DD
><P
>0x00000100  Domain Member</P
></DD
><DT
>SV_TYPE_PRINTQ_SERVER</DT
><DD
><P
>0x00000200  Server sharing print queue</P
></DD
><DT
>SV_TYPE_DIALIN_SERVER</DT
><DD
><P
>0x00000400  Server running dialin service.</P
></DD
><DT
>SV_TYPE_XENIX_SERVER</DT
><DD
><P
>0x00000800  Xenix server</P
></DD
><DT
>SV_TYPE_NT</DT
><DD
><P
>0x00001000  NT server</P
></DD
><DT
>SV_TYPE_WFW</DT
><DD
><P
>0x00002000  Server running Windows for </P
></DD
><DT
>SV_TYPE_SERVER_NT</DT
><DD
><P
>0x00008000  Windows NT non DC server</P
></DD
><DT
>SV_TYPE_POTENTIAL_BROWSER</DT
><DD
><P
>0x00010000  Server that can run the browser service</P
></DD
><DT
>SV_TYPE_BACKUP_BROWSER</DT
><DD
><P
>0x00020000  Backup browser server</P
></DD
><DT
>SV_TYPE_MASTER_BROWSER</DT
><DD
><P
>0x00040000  Master browser server</P
></DD
><DT
>SV_TYPE_DOMAIN_MASTER</DT
><DD
><P
>0x00080000  Domain Master Browser server</P
></DD
><DT
>SV_TYPE_LOCAL_LIST_ONLY</DT
><DD
><P
>0x40000000  Enumerate only entries marked "local"</P
></DD
><DT
>SV_TYPE_DOMAIN_ENUM</DT
><DD
><P
>0x80000000  Enumerate Domains. The pszServer and pszDomain parameters must be NULL.</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>500 - platform_id</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to name</P
></DD
><DT
>UINT32</DT
><DD
><P
>5 - major version</P
></DD
><DT
>UINT32</DT
><DD
><P
>4 - minor version</P
></DD
><DT
>UINT32</DT
><DD
><P
>type (SV_TYPE_... bit field)</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to comment</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>sv101_name - unicode string of server name</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>sv_101_comment  - unicode string of server comment.</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to get unicode string 4-byte aligned with start of the SMB header.</P
></DD
></DL
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN1570">MSRPC over Transact Named Pipe</H2
><P
>For details on the SMB Transact Named Pipe, see cifs6.txt</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1573">MSRPC Pipes</H3
><P
>The MSRPC is conducted over an SMB Transact Pipe with a name of 
<TT
CLASS="FILENAME"
>\PIPE\</TT
>.  You must first obtain a 16 bit file handle, by
sending a SMBopenX with the pipe name <TT
CLASS="FILENAME"
>\PIPE\srvsvc</TT
> for
example.  You can then perform an SMB Trans,
and must carry out an SMBclose on the file handle once you are finished.</P
><P
>Trans Requests must be sent with two setup UINT16s, no UINT16 params (none
known about), and UINT8 data parameters sufficient to contain the MSRPC
header, and MSRPC data.  The first UINT16 setup parameter must be either
0x0026 to indicate an RPC, or 0x0001 to indicate Set Named Pipe Handle
state.  The second UINT16 parameter must be the file handle for the pipe,
obtained above.</P
><P
>The Data section for an API Command of 0x0026 (RPC pipe) in the Trans
Request is the RPC Header, followed by the RPC Data.  The Data section for
an API Command of 0x0001 (Set Named Pipe Handle state) is two bytes.  The
only value seen for these two bytes is 0x00 0x43.</P
><P
>MSRPC Responses are sent as response data inside standard SMB Trans
responses, with the MSRPC Header, MSRPC Data and MSRPC tail.</P
><P
>It is suspected that the Trans Requests will need to be at least 2-byte
aligned (probably 4-byte).  This is standard practice for SMBs.  It is also
independent of the observed 4-byte alignments with the start of the MSRPC
header, including the 4-byte alignment between the MSRPC header and the
MSRPC data.</P
><P
>First, an SMBtconX connection is made to the IPC$ share.  The connection
must be made using encrypted passwords, not clear-text.  Then, an SMBopenX
is made on the pipe.  Then, a Set Named Pipe Handle State must be sent,
after which the pipe is ready to accept API commands.  Lastly, and SMBclose
is sent.</P
><P
>To be resolved:</P
><P
>lkcl/01nov97 there appear to be two additional bytes after the null-terminated \PIPE\ name for the RPC pipe.  Values seen so far are
listed below:</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>        initial SMBopenX request:         RPC API command 0x26 params:
        "\\PIPE\\lsarpc"                  0x65 0x63; 0x72 0x70; 0x44 0x65;
        "\\PIPE\\srvsvc"                  0x73 0x76; 0x4E 0x00; 0x5C 0x43;</PRE
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1587">Header</H3
><P
>[section to be rewritten, following receipt of work by Duncan Stansfield]</P
><P
>Interesting note: if you set packed data representation to 0x0100 0000
then all 4-byte and 2-byte word ordering is turned around!</P
><P
>The start of each of the NTLSA and NETLOGON named pipes begins with:</P
><P
><B
>offset: </B
>00</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>5 - RPC major version</P
><P
><B
>offset: </B
>01</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>0 - RPC minor version</P
><P
><B
>offset: </B
>02</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>2 - RPC response packet</P
><P
><B
>offset: </B
>03</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>3 - (FirstFrag bit-wise or with LastFrag)</P
><P
><B
>offset: </B
>04</P
><P
><B
>Variable type: </B
>UINT32</P
><P
><B
>Variable data: </B
>0x1000 0000 - packed data representation</P
><P
><B
>offset: </B
>08</P
><P
><B
>Variable type: </B
>UINT16</P
><P
><B
>Variable data: </B
>fragment length - data size (bytes) inc header and tail.</P
><P
><B
>offset: </B
>0A</P
><P
><B
>Variable type: </B
>UINT16</P
><P
><B
>Variable data: </B
>0 - authentication length </P
><P
><B
>offset: </B
>0C</P
><P
><B
>Variable type: </B
>UINT32</P
><P
><B
>Variable data: </B
>call identifier. matches 12th UINT32 of incoming RPC data.</P
><P
><B
>offset: </B
>10</P
><P
><B
>Variable type: </B
>UINT32</P
><P
><B
>Variable data: </B
>allocation hint - data size (bytes) minus header and tail.</P
><P
><B
>offset: </B
>14</P
><P
><B
>Variable type: </B
>UINT16</P
><P
><B
>Variable data: </B
>0 - presentation context identifier</P
><P
><B
>offset: </B
>16</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>0 - cancel count</P
><P
><B
>offset: </B
>17</P
><P
><B
>Variable type: </B
>UINT8</P
><P
><B
>Variable data: </B
>in replies: 0 - reserved; in requests: opnum - see #defines.</P
><P
><B
>offset: </B
>18</P
><P
><B
>Variable type: </B
>......</P
><P
><B
>Variable data: </B
>start of data (goes on for allocation_hint bytes)</P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1648">RPC_Packet for request, response, bind and bind acknowledgement</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT8 versionmaj</DT
><DD
><P
>reply same as request (0x05)</P
></DD
><DT
>UINT8 versionmin</DT
><DD
><P
>reply same as request (0x00)</P
></DD
><DT
>UINT8 type</DT
><DD
><P
>one of the MSRPC_Type enums</P
></DD
><DT
>UINT8 flags</DT
><DD
><P
>reply same as request (0x00 for Bind, 0x03 for Request)</P
></DD
><DT
>UINT32 representation</DT
><DD
><P
>reply same as request (0x00000010)</P
></DD
><DT
>UINT16 fraglength</DT
><DD
><P
>the length of the data section of the SMB trans packet</P
></DD
><DT
>UINT16 authlength</DT
><DD
><P
></P
></DD
><DT
>UINT32 callid</DT
><DD
><P
>call identifier. (e.g. 0x00149594)</P
></DD
><DT
>* stub USE TvPacket</DT
><DD
><P
>the remainder of the packet depending on the "type"</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1687">Interface identification</H4
><P
>the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003)
transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002)</PRE
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1692">RPC_Iface RW</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT8 byte[16]</DT
><DD
><P
>16 bytes of number</P
></DD
><DT
>UINT32 version</DT
><DD
><P
>the interface number</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1703">RPC_ReqBind RW</H4
><P
>the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16 maxtsize</DT
><DD
><P
>maximum transmission fragment size (0x1630)</P
></DD
><DT
>UINT16 maxrsize</DT
><DD
><P
>max receive fragment size (0x1630)</P
></DD
><DT
>UINT32 assocgid</DT
><DD
><P
>associated group id (0x0)</P
></DD
><DT
>UINT32 numelements</DT
><DD
><P
>the number of elements (0x1)</P
></DD
><DT
>UINT16 contextid</DT
><DD
><P
>presentation context identifier (0x0)</P
></DD
><DT
>UINT8 numsyntaxes</DT
><DD
><P
>the number of syntaxes (has always been 1?)(0x1)</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>4-byte alignment padding, against SMB header</P
></DD
><DT
>* abstractint USE RPC_Iface</DT
><DD
><P
>num and vers. of interface client is using</P
></DD
><DT
>* transferint USE RPC_Iface</DT
><DD
><P
>num and vers. of interface to use for replies</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1743">RPC_Address RW</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16 length</DT
><DD
><P
>length of the string including null terminator</P
></DD
><DT
>* port USE string</DT
><DD
><P
>the string above in single byte, null terminated form</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1754">RPC_ResBind RW</H4
><P
>the response to place after the header in the reply packet</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16 maxtsize</DT
><DD
><P
>same as request</P
></DD
><DT
>UINT16 maxrsize</DT
><DD
><P
>same as request</P
></DD
><DT
>UINT32 assocgid</DT
><DD
><P
>zero</P
></DD
><DT
>* secondaddr USE RPC_Address</DT
><DD
><P
>the address string, as described earlier</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>4-byte alignment padding, against SMB header</P
></DD
><DT
>UINT8 numresults</DT
><DD
><P
>the number of results (0x01)</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>4-byte alignment padding, against SMB header</P
></DD
><DT
>UINT16 result</DT
><DD
><P
>result (0x00 = accept)</P
></DD
><DT
>UINT16 reason</DT
><DD
><P
>reason (0x00 = no reason specified)</P
></DD
><DT
>* transfersyntax USE RPC_Iface</DT
><DD
><P
>the transfer syntax from the request</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1798">RPC_ReqNorm RW</H4
><P
>the remainder of the packet after the header for every other other request</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32 allochint</DT
><DD
><P
>the size of the stub data in bytes</P
></DD
><DT
>UINT16 prescontext</DT
><DD
><P
>presentation context identifier (0x0)</P
></DD
><DT
>UINT16 opnum</DT
><DD
><P
>operation number (0x15)</P
></DD
><DT
>* stub USE TvPacket</DT
><DD
><P
>a packet dependent on the pipe name (probably the interface) and the op number)</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1818">RPC_ResNorm RW</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32 allochint</DT
><DD
><P
># size of the stub data in bytes</P
></DD
><DT
>UINT16 prescontext</DT
><DD
><P
># presentation context identifier (same as request)</P
></DD
><DT
>UINT8 cancelcount</DT
><DD
><P
># cancel count? (0x0)</P
></DD
><DT
>UINT8 reserved</DT
><DD
><P
># 0 - one byte padding</P
></DD
><DT
>* stub USE TvPacket</DT
><DD
><P
># the remainder of the reply</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1841">Tail</H3
><P
>The end of each of the NTLSA and NETLOGON named pipes ends with:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>......</DT
><DD
><P
>end of data</P
></DD
><DT
>UINT32</DT
><DD
><P
>return code</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1853">RPC Bind / Bind Ack</H3
><P
>RPC Binds are the process of associating an RPC pipe (e.g \PIPE\lsarpc)
with a "transfer syntax" (see RPC_Iface structure).  The purpose for doing
this is unknown.</P
><P
><I
CLASS="EMPHASIS"
>Note: The RPC_ResBind SMB Transact request is sent with two uint16 setup parameters.  The first is 0x0026; the second is the file handle
	returned by the SMBopenX Transact response.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	The RPC_ResBind members maxtsize, maxrsize and assocgid are the same in the response as the same members in the RPC_ReqBind.  The
	RPC_ResBind member transfersyntax is the same in the response as
	the</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	The RPC_ResBind response member secondaddr contains the name of what is presumed to be the service behind the RPC pipe.  The
	mapping identified so far is:</I
></P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>initial SMBopenX request:</DT
><DD
><P
>RPC_ResBind response:</P
></DD
><DT
>"\\PIPE\\srvsvc"</DT
><DD
><P
>"\\PIPE\\ntsvcs"</P
></DD
><DT
>"\\PIPE\\samr"</DT
><DD
><P
>"\\PIPE\\lsass"</P
></DD
><DT
>"\\PIPE\\lsarpc"</DT
><DD
><P
>"\\PIPE\\lsass"</P
></DD
><DT
>"\\PIPE\\wkssvc"</DT
><DD
><P
>"\\PIPE\\wksvcs"</P
></DD
><DT
>"\\PIPE\\NETLOGON"</DT
><DD
><P
>"\\PIPE\\NETLOGON"</P
></DD
></DL
></DIV
><P
><I
CLASS="EMPHASIS"
>Note:	The RPC_Packet fraglength member in both the Bind Request and Bind Acknowledgment must contain the length of the entire RPC data, including the RPC_Packet header.</I
></P
><P
>Request:</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>RPC_Packet</TD
></TR
><TR
><TD
>RPC_ReqBind</TD
></TR
></TBODY
></TABLE
><P
></P
><P
>Response:</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>RPC_Packet</TD
></TR
><TR
><TD
>RPC_ResBind</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1897">NTLSA Transact Named Pipe</H3
><P
>The sequence of actions taken on this pipe are:</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>Establish a connection to the IPC$ share (SMBtconX).  use encrypted passwords.</TD
></TR
><TR
><TD
>Open an RPC Pipe with the name "\\PIPE\\lsarpc".  Store the file handle.</TD
></TR
><TR
><TD
>Using the file handle, send a Set Named Pipe Handle state to 0x4300.</TD
></TR
><TR
><TD
>Send an LSA Open Policy request.  Store the Policy Handle.</TD
></TR
><TR
><TD
>Using the Policy Handle, send LSA Query Info Policy requests, etc.</TD
></TR
><TR
><TD
>Using the Policy Handle, send an LSA Close.</TD
></TR
><TR
><TD
>Close the IPC$ share.</TD
></TR
></TBODY
></TABLE
><P
></P
><P
>Defines for this pipe, identifying the query are:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>LSA Open Policy:</DT
><DD
><P
>0x2c</P
></DD
><DT
>LSA Query Info Policy:</DT
><DD
><P
>0x07</P
></DD
><DT
>LSA Enumerate Trusted Domains:</DT
><DD
><P
>0x0d</P
></DD
><DT
>LSA Open Secret:</DT
><DD
><P
>0xff</P
></DD
><DT
>LSA Lookup SIDs:</DT
><DD
><P
>0xfe</P
></DD
><DT
>LSA Lookup Names:</DT
><DD
><P
>0xfd</P
></DD
><DT
>LSA Close:</DT
><DD
><P
>0x00</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1938">LSA Open Policy</H3
><P
><I
CLASS="EMPHASIS"
>Note:	The policy handle can be anything you like.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1942">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>server name - unicode string starting with two '\'s</P
></DD
><DT
>OBJ_ATTR</DT
><DD
><P
>object attributes</P
></DD
><DT
>UINT32</DT
><DD
><P
>1 - desired access</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1961">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>LSA policy handle</P
></DD
><DT
>return</DT
><DD
><P
>0 - indicates success</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1972">LSA Query Info Policy</H3
><P
><I
CLASS="EMPHASIS"
>Note:	The info class in response must be the same as that in the request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1976">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>LSA policy handle</P
></DD
><DT
>UINT16</DT
><DD
><P
>info class (also a policy handle?)</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN1987">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UINT16</DT
><DD
><P
>info class (same as info class in request).</P
></DD
></DL
></DIV
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>switch (info class)
case 3:
case 5:
{
DOM_INFO domain info, levels 3 and 5 (are the same).
}

return    0 - indicates success</PRE
></TD
></TR
></TABLE
></P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2000">LSA Enumerate Trusted Domains</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN2002">Request</H4
><P
>no extra data</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2005">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>0 - enumeration context</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - entries read</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - trust information</P
></DD
><DT
>return</DT
><DD
><P
>0x8000 001a - "no trusted domains" success code</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2024">LSA Open Secret</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN2026">Request</H4
><P
>no extra data</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2029">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
><DT
>UINT32</DT
><DD
><P
>0 - undocumented</P
></DD
></DL
></DIV
><P
>return    0x0C00 0034 - "no such secret" success code</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2053">LSA Close</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN2055">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>policy handle to be closed</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2062">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>0s - closed policy handle (all zeros)</P
></DD
></DL
></DIV
><P
>return    0 - indicates success</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2070">LSA Lookup SIDS</H3
><P
><I
CLASS="EMPHASIS"
>Note:	num_entries in response must be same as num_entries in request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2074">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>LSA policy handle</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain SID buffer pointer</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain name buffer pointer</P
></DD
><DT
>VOID*[num_entries] undocumented domain SID pointers to be looked up.</DT
><DD
><P
>DOM_SID[num_entries] domain SIDs to be looked up.</P
></DD
><DT
>char[16]</DT
><DD
><P
>completely undocumented 16 bytes.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2101">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>DOM_REF</DT
><DD
><P
>domain reference response</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
><DT
>DOM_SID2[num_entries]</DT
><DD
><P
>domain SIDs (from Request, listed above).</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
></DL
></DIV
><P
>return                0 - indicates success</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2129">LSA Lookup Names</H3
><P
><I
CLASS="EMPHASIS"
>Note:	num_entries in response must be same as num_entries in request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2133">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>POL_HND</DT
><DD
><P
>LSA policy handle</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain SID buffer pointer</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented domain name buffer pointer</P
></DD
><DT
>NAME[num_entries]</DT
><DD
><P
>names to be looked up.</P
></DD
><DT
>char[]</DT
><DD
><P
>undocumented bytes - falsely translated SID structure?</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2164">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>DOM_REF</DT
><DD
><P
>domain reference response</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
><DT
>DOM_RID[num_entries]</DT
><DD
><P
>domain SIDs (from Request, listed above).</P
></DD
><DT
>UINT32</DT
><DD
><P
>num_entries (listed above)</P
></DD
></DL
></DIV
><P
>return                0 - indicates success</P
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2192">NETLOGON rpc Transact Named Pipe</H2
><P
>The sequence of actions taken on this pipe are:</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>tablish a connection to the IPC$ share (SMBtconX).  use encrypted passwords.</TD
></TR
><TR
><TD
>en an RPC Pipe with the name "\\PIPE\\NETLOGON".  Store the file handle.</TD
></TR
><TR
><TD
>ing the file handle, send a Set Named Pipe Handle state to 0x4300.</TD
></TR
><TR
><TD
>eate Client Challenge. Send LSA Request Challenge.  Store Server Challenge.</TD
></TR
><TR
><TD
>lculate Session Key.  Send an LSA Auth 2 Challenge.  Store Auth2 Challenge.</TD
></TR
><TR
><TD
>lc/Verify Client Creds.  Send LSA Srv PW Set.  Calc/Verify Server Creds.</TD
></TR
><TR
><TD
>lc/Verify Client Creds.  Send LSA SAM Logon .  Calc/Verify Server Creds.</TD
></TR
><TR
><TD
>lc/Verify Client Creds.  Send LSA SAM Logoff.  Calc/Verify Server Creds.</TD
></TR
><TR
><TD
>ose the IPC$ share.</TD
></TR
></TBODY
></TABLE
><P
></P
><P
>Defines for this pipe, identifying the query are</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>LSA Request Challenge:</DT
><DD
><P
>0x04</P
></DD
><DT
>LSA Server Password Set:</DT
><DD
><P
>0x06</P
></DD
><DT
>LSA SAM Logon:</DT
><DD
><P
>0x02</P
></DD
><DT
>LSA SAM Logoff:</DT
><DD
><P
>0x03</P
></DD
><DT
>LSA Auth 2:</DT
><DD
><P
>0x0f</P
></DD
><DT
>LSA Logon Control:</DT
><DD
><P
>0x0e</P
></DD
></DL
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2231">LSA Request Challenge</H3
><P
><I
CLASS="EMPHASIS"
>Note:	logon server name starts with two '\' characters and is upper case.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	logon client is the machine, not the user.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	the initial LanManager password hash, against which the challenge is issued, is the machine name itself (lower case).  there will becalls issued (LSA Server Password Set) which will change this, later. refusing these calls allows you to always deal with the same password (i.e the LM# of the machine name in lower case).</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2239">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon server unicode string</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>logon client unicode string</P
></DD
><DT
>char[8]</DT
><DD
><P
>client challenge</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2258">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>char[8]</DT
><DD
><P
>server challenge</P
></DD
></DL
></DIV
><P
>return    0 - indicates success</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2266">LSA Authenticate 2</H3
><P
><I
CLASS="EMPHASIS"
>Note:	in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	neg_flags in the response is the same as that in the request.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	you must take a copy of the client-calculated credentials received 	here, because they will be used in subsequent authentication packets.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2274">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>LOG_INFO</DT
><DD
><P
>client identification info</P
></DD
><DT
>char[8]</DT
><DD
><P
>client-calculated credentials</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to 4-byte align with start of SMB header.</P
></DD
><DT
>UINT32</DT
><DD
><P
>neg_flags - negotiated flags (usual value is 0x0000 01ff)</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2293">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>char[8]</DT
><DD
><P
>server credentials.</P
></DD
><DT
>UINT32</DT
><DD
><P
>neg_flags - same as neg_flags in request.</P
></DD
></DL
></DIV
><P
>return    0 - indicates success.  failure value unknown.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2305">LSA Server Password Set</H3
><P
><I
CLASS="EMPHASIS"
>Note: the new password is suspected to be a DES encryption using the old password to generate the key.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</I
></P
><P
><I
CLASS="EMPHASIS"
>Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2315">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>CLNT_INFO</DT
><DD
><P
>client identification/authentication info</P
></DD
><DT
>char[]</DT
><DD
><P
>new password - undocumented.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2326">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>CREDS</DT
><DD
><P
>server credentials.  server time stamp appears to be ignored.</P
></DD
></DL
></DIV
><P
>return    0 - indicates success; 0xC000 006a indicates failure</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2334">LSA SAM Logon</H3
><P
><I
CLASS="EMPHASIS"
>Note:	valid_user is True iff the username and password hash are valid for
	the requested domain.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2338">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>SAM_INFO</DT
><DD
><P
>sam_id structure</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2345">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>CREDS</DT
><DD
><P
>server credentials.  server time stamp appears to be ignored.</P
></DD
></DL
></DIV
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>if (valid_user)
{
	UINT16      3 - switch value indicating USER_INFO structure.
    VOID*     non-zero - pointer to USER_INFO structure
    USER_INFO user logon information

    UINT32    1 - Authoritative response; 0 - Non-Auth?

    return    0 - indicates success
}
else
{
	UINT16    0 - switch value.  value to indicate no user presumed.
    VOID*     0x0000 0000 - indicates no USER_INFO structure.

    UINT32    1 - Authoritative response; 0 - Non-Auth?

    return    0xC000 0064 - NT_STATUS_NO_SUCH_USER.
}</PRE
></TD
></TR
></TABLE
></P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2358">LSA SAM Logoff</H3
><P
><I
CLASS="EMPHASIS"
>Note:	presumably, the SAM_INFO structure is validated, and a (currently
	undocumented) error code returned if the Logoff is invalid.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2362">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>SAM_INFO</DT
><DD
><P
>sam_id structure</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2369">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>undocumented buffer pointer</P
></DD
><DT
>CREDS</DT
><DD
><P
>server credentials.  server time stamp appears to be ignored.</P
></DD
></DL
></DIV
><P
>return      0 - indicates success.  undocumented failure indication.</P
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2381">\\MAILSLOT\NET\NTLOGON</H2
><P
><I
CLASS="EMPHASIS"
>Note:	mailslots will contain a response mailslot, to which the response
	should be sent.  the target NetBIOS name is REQUEST_NAME&#60;20&#62;, where
	REQUEST_NAME is the name of the machine that sent the request.</I
></P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2385">Query for PDC</H3
><P
><I
CLASS="EMPHASIS"
>Note:	NTversion, LMNTtoken, LM20token in response are the same as those 	given in the request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2389">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16</DT
><DD
><P
>0x0007 - Query for PDC</P
></DD
><DT
>STR</DT
><DD
><P
>machine name</P
></DD
><DT
>STR</DT
><DD
><P
>response mailslot</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to 2-byte align with start of mailslot.</P
></DD
><DT
>UNISTR</DT
><DD
><P
>machine name</P
></DD
><DT
>UINT32</DT
><DD
><P
>NTversion</P
></DD
><DT
>UINT16</DT
><DD
><P
>LMNTtoken</P
></DD
><DT
>UINT16</DT
><DD
><P
>LM20token</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2424">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16</DT
><DD
><P
>0x000A - Respose to Query for PDC</P
></DD
><DT
>STR</DT
><DD
><P
>machine name (in uppercase)</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to 2-byte align with start of mailslot.</P
></DD
><DT
>UNISTR</DT
><DD
><P
>machine name</P
></DD
><DT
>UNISTR</DT
><DD
><P
>domain name</P
></DD
><DT
>UINT32</DT
><DD
><P
>NTversion (same as received in request)</P
></DD
><DT
>UINT16</DT
><DD
><P
>LMNTtoken (same as received in request)</P
></DD
><DT
>UINT16</DT
><DD
><P
>LM20token (same as received in request)</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2459">SAM Logon</H3
><P
><I
CLASS="EMPHASIS"
>Note: machine name in response is preceded by two '\' characters.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	user name in the response is presumably the same as that in the request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2467">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16</DT
><DD
><P
>0x0012 - SAM Logon</P
></DD
><DT
>UINT16</DT
><DD
><P
>request count</P
></DD
><DT
>UNISTR</DT
><DD
><P
>machine name</P
></DD
><DT
>UNISTR</DT
><DD
><P
>user name</P
></DD
><DT
>STR</DT
><DD
><P
>response mailslot</P
></DD
><DT
>UINT32</DT
><DD
><P
>alloweable account</P
></DD
><DT
>UINT32</DT
><DD
><P
>domain SID size</P
></DD
><DT
>char[sid_size]</DT
><DD
><P
>domain SID, of sid_size bytes.</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>???? padding to 4? 2? -byte align with start of mailslot.</P
></DD
><DT
>UINT32</DT
><DD
><P
>NTversion</P
></DD
><DT
>UINT16</DT
><DD
><P
>LMNTtoken</P
></DD
><DT
>UINT16</DT
><DD
><P
>LM20token</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2518">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT16</DT
><DD
><P
>0x0013 - Response to SAM Logon</P
></DD
><DT
>UNISTR</DT
><DD
><P
>machine name</P
></DD
><DT
>UNISTR</DT
><DD
><P
>user name - workstation trust account</P
></DD
><DT
>UNISTR</DT
><DD
><P
>domain name </P
></DD
><DT
>UINT32</DT
><DD
><P
>NTversion</P
></DD
><DT
>UINT16</DT
><DD
><P
>LMNTtoken</P
></DD
><DT
>UINT16</DT
><DD
><P
>LM20token</P
></DD
></DL
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2549">SRVSVC Transact Named Pipe</H2
><P
>Defines for this pipe, identifying the query are:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>Net Share Enum</DT
><DD
><P
>0x0f</P
></DD
><DT
>Net Server Get Info</DT
><DD
><P
>0x15</P
></DD
></DL
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2561">Net Share Enum</H3
><P
><I
CLASS="EMPHASIS"
>Note:	share level and switch value in the response are presumably the same as those in the request.</I
></P
><P
><I
CLASS="EMPHASIS"
>Note:	cifsrap2.txt (section 5) may be of limited assistance here.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2567">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>VOID*</DT
><DD
><P
>pointer (to server name?)</P
></DD
><DT
>UNISTR2</DT
><DD
><P
>server name</P
></DD
><DT
>UINT8[]</DT
><DD
><P
>padding to get unicode string 4-byte aligned with the start of the SMB header.</P
></DD
><DT
>UINT32</DT
><DD
><P
>share level</P
></DD
><DT
>UINT32</DT
><DD
><P
>switch value</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to SHARE_INFO_1_CTR</P
></DD
><DT
>SHARE_INFO_1_CTR</DT
><DD
><P
>share info with 0 entries</P
></DD
><DT
>UINT32</DT
><DD
><P
>preferred maximum length (0xffff ffff)</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2602">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>share level</P
></DD
><DT
>UINT32</DT
><DD
><P
>switch value</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to SHARE_INFO_1_CTR</P
></DD
><DT
>SHARE_INFO_1_CTR</DT
><DD
><P
>share info (only added if share info ptr is non-zero)</P
></DD
></DL
></DIV
><P
>return            0 - indicates success</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2622">Net Server Get Info</H3
><P
><I
CLASS="EMPHASIS"
>Note:	level is the same value as in the request.</I
></P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2626">Request</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UNISTR2</DT
><DD
><P
>server name</P
></DD
><DT
>UINT32</DT
><DD
><P
>switch level</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2637">Response</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>UINT32</DT
><DD
><P
>switch level</P
></DD
><DT
>VOID*</DT
><DD
><P
>pointer to SERVER_INFO_101</P
></DD
><DT
>SERVER_INFO_101</DT
><DD
><P
>server info (only added if server info ptr is non-zero)</P
></DD
></DL
></DIV
><P
>return            0 - indicates success</P
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2653">Cryptographic side of NT Domain Authentication</H2
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
NAME="AEN2655">Definitions</H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>Add(A1,A2)</DT
><DD
><P
>Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2</P
></DD
><DT
>E(K,D)</DT
><DD
><P
>DES ECB encryption of 8 byte data D using 7 byte key K</P
></DD
><DT
>lmowf()</DT
><DD
><P
>Lan man hash</P
></DD
><DT
>ntowf()</DT
><DD
><P
>NT hash</P
></DD
><DT
>PW</DT
><DD
><P
>md4(machine_password) == md4(lsadump $machine.acc) ==
pwdump(machine$) (initially) == md4(lmowf(unicode(machine)))</P
></DD
><DT
>ARC4(K,Lk,D,Ld)</DT
><DD
><P
>ARC4 encryption of data D of length Ld with key K of length Lk</P
></DD
><DT
>v[m..n(,l)]</DT
><DD
><P
>subset of v from bytes m to n, optionally padded with zeroes to length l</P
></DD
><DT
>Cred(K,D)</DT
><DD
><P
>E(K[7..7,7],E(K[0..6],D)) computes a credential</P
></DD
><DT
>Time()</DT
><DD
><P
>4 byte current time</P
></DD
><DT
>Cc,Cs</DT
><DD
><P
>8 byte client and server challenges Rc,Rs: 8 byte client and server credentials</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2698">Protocol</H3
><P
>C-&#62;S ReqChal,Cc S-&#62;C Cs</P
><P
>C &#38; S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs)))</P
><P
>C: Rc = Cred(Ks,Cc) C-&#62;S Authenticate,Rc S: Rs = Cred(Ks,Cs),
assert(Rc == Cred(Ks,Cc)) S-&#62;C Rs C: assert(Rs == Cred(Ks,Cs))</P
><P
>On joining the domain the client will optionally attempt to change its
password and the domain controller may refuse to update it depending
on registry settings. This will also occur weekly afterwards.</P
><P
>C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) C-&#62;S ServerPasswordSet,Rc',Tc,
arc4(Ks[0..7,16],lmowf(randompassword()) C: Rc = Cred(Ks,Rc+Tc+1) S:
assert(Rc' == Cred(Ks,Rc+Tc)), Ts = Time() S: Rs' = Cred(Ks,Rs+Tc+1)
S-&#62;C Rs',Ts C: assert(Rs' == Cred(Ks,Rs+Tc+1)) S: Rs = Rs'</P
><P
>User: U with password P wishes to login to the domain (incidental data
such as workstation and domain omitted)</P
><P
>C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) C-&#62;S NetLogonSamLogon,Rc',Tc,U,
arc4(Ks[0..7,16],16,ntowf(P),16), arc4(Ks[0..7,16],16,lmowf(P),16) S:
assert(Rc' == Cred(Ks,Rc+Tc)) assert(passwords match those in SAM) S:
Ts = Time()</P
><P
>S-&#62;C Cred(Ks,Cred(Ks,Rc+Tc+1)),userinfo(logon script,UID,SIDs,etc) C:
assert(Rs == Cred(Ks,Cred(Rc+Tc+1)) C: Rc = Cred(Ks,Rc+Tc+1)</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2708">Comments</H3
><P
>On first joining the domain the session key could be computed by
anyone listening in on the network as the machine password has a well
known value. Until the machine is rebooted it will use this session
key to encrypt NT and LM one way functions of passwords which are
password equivalents. Any user who logs in before the machine has been
rebooted a second time will have their password equivalent exposed. Of
course the new machine password is exposed at this time anyway.</P
><P
>None of the returned user info such as logon script, profile path and
SIDs *appear* to be protected by anything other than the TCP checksum.</P
><P
>The server time stamps appear to be ignored.</P
><P
>The client sends a ReturnAuthenticator in the SamLogon request which I
can't find a use for.  However its time is used as the timestamp
returned by the server.</P
><P
>The password OWFs should NOT be sent over the network reversibly
encrypted. They should be sent using ARC4(Ks,md4(owf)) with the server
computing the same function using the owf values in the SAM.</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2715">SIDs and RIDs</H2
><P
>SIDs and RIDs are well documented elsewhere.</P
><P
>A SID is an NT Security ID (see DOM_SID structure).  They are of the form:</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>revision-NN-SubAuth1-SubAuth2-SubAuth3... </TD
></TR
><TR
><TD
>revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...</TD
></TR
></TBODY
></TABLE
><P
></P
><P
>currently, the SID revision is 1.
The Sub-Authorities are known as Relative IDs (RIDs).</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2723">Well-known SIDs</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
NAME="AEN2725">Universal well-known SIDs</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>Null SID</DT
><DD
><P
>S-1-0-0</P
></DD
><DT
>World</DT
><DD
><P
>S-1-1-0</P
></DD
><DT
>Local</DT
><DD
><P
>S-1-2-0</P
></DD
><DT
>Creator Owner ID</DT
><DD
><P
>S-1-3-0</P
></DD
><DT
>Creator Group ID</DT
><DD
><P
>S-1-3-1</P
></DD
><DT
>Creator Owner Server ID</DT
><DD
><P
>S-1-3-2</P
></DD
><DT
>Creator Group Server ID</DT
><DD
><P
>S-1-3-3</P
></DD
><DT
>(Non-unique IDs)</DT
><DD
><P
>S-1-4</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2760">NT well-known SIDs</H4
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>NT Authority</DT
><DD
><P
>S-1-5</P
></DD
><DT
>Dialup</DT
><DD
><P
>S-1-5-1</P
></DD
><DT
>Network</DT
><DD
><P
>S-1-5-2</P
></DD
><DT
>Batch</DT
><DD
><P
>S-1-5-3</P
></DD
><DT
>Interactive</DT
><DD
><P
>S-1-5-4</P
></DD
><DT
>Service</DT
><DD
><P
>S-1-5-6</P
></DD
><DT
>AnonymousLogon(aka null logon session)</DT
><DD
><P
>S-1-5-7</P
></DD
><DT
>Proxy</DT
><DD
><P
>S-1-5-8</P
></DD
><DT
>ServerLogon(aka domain controller account)</DT
><DD
><P
>S-1-5-8</P
></DD
><DT
>(Logon IDs)</DT
><DD
><P
>S-1-5-5-X-Y</P
></DD
><DT
>(NT non-unique IDs)</DT
><DD
><P
>S-1-5-0x15-...</P
></DD
><DT
>(Built-in domain)</DT
><DD
><P
>s-1-5-0x20</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2811">Well-known RIDS</H3
><P
>A RID is a sub-authority value, as part of either a SID, or in the case
of Group RIDs, part of the DOM_GID structure, in the USER_INFO_1
structure, in the LSA SAM Logon response.</P
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2814">Well-known RID users</H4
><P
><B
>Groupname: </B
>DOMAIN_USER_RID_ADMIN</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>01F4</P
><P
><B
>Groupname: </B
>DOMAIN_USER_RID_GUEST</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>01F5</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2828">Well-known RID groups</H4
><P
><B
>Groupname: </B
>	DOMAIN_GROUP_RID_ADMINS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0200</P
><P
><B
>Groupname: </B
>	DOMAIN_GROUP_RID_USERS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0201</P
><P
><B
>Groupname: </B
>	DOMAIN_GROUP_RID_GUESTS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0202</P
></DIV
><DIV
CLASS="SECT3"
><HR><H4
CLASS="SECT3"
><A
NAME="AEN2846">Well-known RID aliases</H4
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_ADMINS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0220</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_USERS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0221</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_GUESTS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0222</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_POWER_USERS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0223</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_ACCOUNT_OPS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0224</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_SYSTEM_OPS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0225</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_PRINT_OPS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0226</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_BACKUP_OPS</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0227</P
><P
><B
>Groupname: </B
>	DOMAIN_ALIAS_RID_REPLICATOR</P
><P
><B
>????: </B
>0x0000</P
><P
><B
>RID: </B
>0228</P
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="PRINTING">Samba Printing Internals</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN2895">Abstract</H2
><P
>The purpose of this document is to provide some insight into
Samba's printing functionality and also to describe the semantics
of certain features of Windows client printing.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2898">Printing Interface to Various Back ends</H2
><P
>Samba uses a table of function pointers to seven functions.  The
function prototypes are defined in the <TT
CLASS="VARNAME"
>printif</TT
> structure declared
in <TT
CLASS="FILENAME"
>printing.h</TT
>.</P
><P
></P
><UL
><LI
><P
>retrieve the contents of a print queue</P
></LI
><LI
><P
>pause the print queue</P
></LI
><LI
><P
>resume a paused print queue</P
></LI
><LI
><P
>delete a job from the queue</P
></LI
><LI
><P
>pause a job in the print queue</P
></LI
><LI
><P
>result a paused print job in the queue</P
></LI
><LI
><P
>submit a job to the print queue</P
></LI
></UL
><P
>Currently there are only two printing back end implementations
defined.</P
><P
></P
><UL
><LI
><P
>a generic set of functions for working with standard UNIX
	printing subsystems</P
></LI
><LI
><P
>a set of CUPS specific functions (this is only enabled if
	the CUPS libraries were located at compile time).</P
></LI
></UL
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2924">Print Queue TDB's</H2
><P
>Samba provides periodic caching of the output from the "lpq command"
for performance reasons.  This cache time is configurable in seconds.
Obviously the longer the cache time the less often smbd will be
required to exec a copy of lpq.  However, the accuracy of the print
queue contents displayed to clients will be diminished as well.</P
><P
>The list of currently opened print queue TDB's can be found
be examining the list of tdb_print_db structures ( see print_db_head
in printing.c ). A queue TDB is opened using the wrapper function
printing.c:get_print_db_byname().  The function ensures that smbd
does not open more than MAX_PRINT_DBS_OPEN in an effort to prevent
a large print server from exhausting all available file descriptors.
If the number of open queue TDB's exceeds the MAX_PRINT_DBS_OPEN
limit, smbd falls back to a most recently used algorithm for maintaining
a list of open TDB's.</P
><P
>There are two ways in which a a print job can be entered into
a print queue's TDB.  The first is to submit the job from a Windows
client which will insert the job information directly into the TDB.
The second method is to have the print job picked up by executing the
"lpq command".</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>/* included from printing.h */
struct printjob {
	pid_t pid; /* which process launched the job */
	int sysjob; /* the system (lp) job number */
	int fd; /* file descriptor of open file if open */
	time_t starttime; /* when the job started spooling */
	int status; /* the status of this job */
	size_t size; /* the size of the job so far */
	int page_count;	/* then number of pages so far */
	BOOL spooled; /* has it been sent to the spooler yet? */
	BOOL smbjob; /* set if the job is a SMB job */
	fstring filename; /* the filename used to spool the file */
	fstring jobname; /* the job name given to us by the client */
	fstring user; /* the user who started the job */
	fstring queuename; /* service number of printer for this job */
	NT_DEVICEMODE *nt_devmode;
};</PRE
></TD
></TR
></TABLE
></P
><P
>The current manifestation of the printjob structure contains a field
for the UNIX job id returned from the "lpq command" and a Windows job
ID (32-bit bounded by PRINT_MAX_JOBID).  When a print job is returned
by the "lpq command" that does not match an existing job in the queue's
TDB, a 32-bit job ID above the &#60;*vance doesn't know what word is missing here*&#62; is generating by adding UNIX_JOB_START to
the id reported by lpq.</P
><P
>In order to match a 32-bit Windows jobid onto a 16-bit lanman print job
id, smbd uses an in memory TDB to match the former to a number appropriate
for old lanman clients.</P
><P
>When updating a print queue, smbd will perform the following
steps ( refer to <TT
CLASS="FILENAME"
>print.c:print_queue_update()</TT
> ):</P
><P
></P
><OL
TYPE="1"
><LI
><P
>Check to see if another smbd is currently in 
	the process of updating the queue contents by checking the pid 
	stored in <TT
CLASS="CONSTANT"
>LOCK/<TT
CLASS="REPLACEABLE"
><I
>printer_name</I
></TT
></TT
>.  
	If so, then do not update the TDB.</P
></LI
><LI
><P
>Lock the mutex entry in the TDB and store our own pid.
	Check that this succeeded, else fail.</P
></LI
><LI
><P
>Store the updated time stamp for the new cache
	listing</P
></LI
><LI
><P
>Retrieve the queue listing via "lpq command"</P
></LI
><LI
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	foreach job in the queue
     	{
		if the job is a UNIX job, create a new entry;
		if the job has a Windows based jobid, then
		{
			Lookup the record by the jobid;
			if the lookup failed, then
				treat it as a UNIX job;
			else
				update the job status only
		}
	}</PRE
></TD
></TR
></TABLE
></P
></LI
><LI
><P
>Delete any jobs in the TDB that are not
	in the in the lpq listing</P
></LI
><LI
><P
>Store the print queue status in the TDB</P
></LI
><LI
><P
>update the cache time stamp again</P
></LI
></OL
><P
>Note that it is the contents of this TDB that is returned to Windows
clients and not the actual listing from the "lpq command".</P
><P
>The NT_DEVICEMODE stored as part of the printjob structure is used to
store a pointer to a non-default DeviceMode associated with the print
job.  The pointer will be non-null when the client included a Device
Mode in the OpenPrinterEx() call and subsequently submitted a job for
printing on that same handle.  If the client did not include a Device
Mode in the OpenPrinterEx() request, the nt_devmode field is NULL
and the job has the printer's device mode associated with it by default.</P
><P
>Only non-default Device Mode are stored with print jobs in the print
queue TDB.  Otherwise, the Device Mode is obtained from the printer
object when the client issues a GetJob(level == 2) request.</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2958">ChangeID &#38; Client Caching of Printer Information</H2
><P
>[To be filled in later]</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN2961">Windows NT/2K Printer Change Notify</H2
><P
>When working with Windows NT+ clients, it is possible for a
print server to use RPC to send asynchronous change notification
events to clients for certain printer and print job attributes.
This can be useful when the client needs to know that a new
job has been added to the queue for a given printer or that the
driver for a printer has been changed.  Note that this is done
entirely orthogonal to cache updates based on a new ChangeID for
a printer object.</P
><P
>The basic set of RPC's used to implement change notification are</P
><P
></P
><UL
><LI
><P
>RemoteFindFirstPrinterChangeNotifyEx ( RFFPCN )</P
></LI
><LI
><P
>RemoteFindNextPrinterChangeNotifyEx ( RFNPCN )</P
></LI
><LI
><P
>FindClosePrinterChangeNotify( FCPCN )</P
></LI
><LI
><P
>ReplyOpenPrinter</P
></LI
><LI
><P
>ReplyClosePrinter</P
></LI
><LI
><P
>RouteRefreshPrinterChangeNotify ( RRPCN )</P
></LI
></UL
><P
>One additional RPC is available to a server, but is never used by the
Windows spooler service:</P
><P
></P
><UL
><LI
><P
>RouteReplyPrinter()</P
></LI
></UL
><P
>The opnum for all of these RPC's are defined in include/rpc_spoolss.h</P
><P
>Windows NT print servers use a bizarre method of sending print
notification event to clients.  The process of registering a new change
notification handle is as follows.  The 'C' is for client and the
'S' is for server.  All error conditions have been eliminated.</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>C:	Obtain handle to printer or to the printer
	server via the standard OpenPrinterEx() call.
S:	Respond with a valid handle to object

C:	Send a RFFPCN request with the previously obtained
	handle with either (a) set of flags for change events
	to monitor, or (b) a PRINTER_NOTIFY_OPTIONS structure
	containing the event information to monitor.  The windows
	spooler has only been observed to use (b).
S:	The &#60;* another missing word*&#62; opens a new TCP session to the client (thus requiring
	all print clients to be CIFS servers as well) and sends
	a ReplyOpenPrinter() request to the client.
C:	The client responds with a printer handle that can be used to
	send event notification messages.
S:	The server replies success to the RFFPCN request.

C:	The windows spooler follows the RFFPCN with a RFNPCN
	request to fetch the current values of all monitored
	attributes.
S:	The server replies with an array SPOOL_NOTIFY_INFO_DATA
	structures (contained in a SPOOL_NOTIFY_INFO structure).

C:	If the change notification handle is ever released by the
	client via a FCPCN request, the server sends a ReplyClosePrinter()
	request back to the client first.  However a request of this
	nature from the client is often an indication that the previous
	notification event was not marshalled correctly by the server
	or a piece of data was wrong.
S:	The server closes the internal change notification handle
	(POLICY_HND) and does not send any further change notification
	events to the client for that printer or job.</PRE
></TD
></TR
></TABLE
></P
><P
>The current list of notification events supported by Samba can be
found by examining the internal tables in srv_spoolss_nt.c</P
><P
></P
><UL
><LI
><P
>printer_notify_table[]</P
></LI
><LI
><P
>job_notify_table[]</P
></LI
></UL
><P
>When an event occurs that could be monitored, smbd sends a message
to itself about the change.  The list of events to be transmitted
are queued by the smbd process sending the message to prevent an
overload of TDB usage and the internal message is sent during smbd's
idle loop (refer to printing/notify.c and the functions
send_spoolss_notify2_msg() and print_notify_send_messages() ).</P
><P
>The decision of whether or not the change is to be sent to connected
clients is made by the routine which actually sends the notification.
( refer to srv_spoolss_nt.c:recieve_notify2_message() ).</P
><P
>Because it possible to receive a listing of multiple changes for
multiple printers, the notification events must be split into
categories by the printer name.  This makes it possible to group
multiple change events to be sent in a single RPC according to the
printer handle obtained via a ReplyOpenPrinter().</P
><P
>The actual change notification is performed using the RRPCN request
RPC.  This packet contains</P
><P
></P
><UL
><LI
><P
>the printer handle registered with the
client's spooler on which the change occurred</P
></LI
><LI
><P
>The change_low value which was sent as part
of the last RFNPCN request from the client</P
></LI
><LI
><P
>The SPOOL_NOTIFY_INFO container with the event
information</P
></LI
></UL
><P
>A <TT
CLASS="VARNAME"
>SPOOL_NOTIFY_INFO</TT
> contains:</P
><P
></P
><UL
><LI
><P
>the version and flags field are predefined
and should not be changed</P
></LI
><LI
><P
>The count field is the number of entries
in the SPOOL_NOTIFY_INFO_DATA array</P
></LI
></UL
><P
>The <TT
CLASS="VARNAME"
>SPOOL_NOTIFY_INFO_DATA</TT
> entries contain:</P
><P
></P
><UL
><LI
><P
>The type defines whether or not this event
is for a printer or a print job</P
></LI
><LI
><P
>The field is the flag identifying the event</P
></LI
><LI
><P
>the notify_data union contains the new valuie of the
attribute</P
></LI
><LI
><P
>The enc_type defines the size of the structure for marshalling
and unmarshalling</P
></LI
><LI
><P
>(a) the id must be 0 for a printer event on a printer handle.
(b) the id must be the job id for an event on a printer job
(c) the id must be the matching number of the printer index used
in the response packet to the RFNPCN when using a print server
handle for notification.  Samba currently uses the snum of
the printer for this which can break if the list of services
has been modified since the notification handle was registered.</P
></LI
><LI
><P
>The size is either (a) the string length in UNICODE for strings,
(b) the size in bytes of the security descriptor, or (c) 0 for
data values.</P
></LI
></UL
></DIV
></DIV
><DIV
CLASS="CHAPTER"
><HR><H1
><A
NAME="WINS">Samba WINS Internals</H1
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN3032">WINS Failover</H2
><P
>The current Samba codebase possesses the capability to use groups of WINS
servers that share a common namespace for NetBIOS name registration and 
resolution.  The formal parameter syntax is</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	WINS_SERVER_PARAM 	= SERVER [ SEPARATOR SERVER_LIST ]
	WINS_SERVER_PARAM 	= "wins server"
	SERVER 			= ADDR[:TAG]
	ADDR 			= ip_addr | fqdn
	TAG 			= string
	SEPARATOR		= comma | \s+
	SERVER_LIST		= SERVER [ SEPARATOR SERVER_LIST ]</PRE
></TD
></TR
></TABLE
></P
><P
>A simple example of a valid wins server setting is</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>[global]
	wins server = 192.168.1.2 192.168.1.3</PRE
></TD
></TR
></TABLE
></P
><P
>In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default
TAG of "*".  A TAG is used to group servers of a shared NetBIOS namespace together.  Upon
startup, nmbd will attempt to register the netbios name value with one server in each
tagged group.</P
><P
>An example using tags to group WINS servers together is show here.  Note that the use of
interface names in the tags is only by convention and is not a technical requirement.</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>[global]
	wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1</PRE
></TD
></TR
></TABLE
></P
><P
>Using this configuration, nmbd would attempt to register the server's NetBIOS name 
with one WINS server in each group.  Because the "eth0" group has two servers, the 
second server would only be used when a registration (or resolution) request to 
the first server in that group timed out.</P
><P
>NetBIOS name resolution follows a similar pattern as name registration.  When resolving 
a NetBIOS name via WINS, smbd and other Samba programs will attempt to query a single WINS 
server in a tagged group until either a positive response is obtained at least once or 
until a server from every tagged group has responded negatively to the name query request.
If a timeout occurs when querying a specific WINS server, that server is marked as down to 
prevent further timeouts and the next server in the WINS group is contacted.  Once marked as 
dead, Samba will not attempt to contact that server for name registration/resolution queries 
for a period of 10 minutes.</P
></DIV
></DIV
></DIV
></BODY
></HTML
>
generated by cgit (git 2.34.1) at 2024-11-08 05:49:55 +0000