pike.git/lib/modules/Protocols.pmod/LDAP.pmod/client.pike:e254441b0fe0c6188fe2a2e6b6e2e92ca11780c8

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 #pike __REAL_VERSION__ // LDAP client protocol implementation for Pike. // // $Id: client.pike,v 1.46 2002/11/27 22:04:32 marcus Exp $ // // Honza Petrous, hop@unibase.cz // // ---------------------------------------------------------------------- // // History: // // v0.0 1998-05-25 Starting up! // v1.0 1998-06-21 Core functions (open, bind, unbind, delete, add, // compare, search), only V2 operations, // some additional restrictions // v1.1u 1998-07-03 Unfinished version (for testing) // v1.2a 1998-07-14 New beta code (I love jump over versions like Roxen ;) // - added asn1_enumerated, asn1_boolean, asn1_nulllist // and asn1_application_null // - search op: corrected ASN1 type // - unbind op: corrected ASN1 type // v1.2d 1998-08 - added logging of bad LDAP PDU in readmsg // v1.3 1998-09-18 - resolved "null attribute list" bug in search // (Now is compatible with MS Exchange ;-) // v1.9 1999-03 - redesign of LDAP.pmod // !!! Library uses new ASN1 API => uncompatible !!! // !!! with Pike 0.5 (needed Pike 0.6 or higher) !!! // - sliced library code to the several files: // * LDAP.pmod/protocol.pike // (low level code) // * LDAP.pmod/client.pike // (main code) // * LDAP.pmod/ldap_errors.h // (error array) // * LDAP.pmod/ldap_globals.h // (global defininitions) // * LDAP.pmod/ldap_privates.pmod // (ASN.1 LDAP-related classes and hacks) // - changed default of 'ldap_scope' to 0 // - search filter now correctly processed '$' & '$' // [! Still unimplemented escaped conditions chars!] // // v1.10 1999-03-28 - moved core to the new 'protocol' code // 1999-03-28 - rewritten ldap_[op] startup code // // v1.11 1999-04-10 - search filter now processed multiple wild '*' chars // [ Escaping untested, yet ] // v1.13 2000-02-12 - fixed search NOT op bug (end revision normalized) // // v1.14 2000-02-17 - added decoding of UTF8 strings for v3 protocol // // newer versions - see CVS at roxen.com (hop) // // - corrected deUTF8 values in result // - // // Specifications: // // RFC 1558 (search filter representations) // RFC 1777,1778,1779 (version2 spec) // RFC 1823 (v2 API) // RFC 2251,2252,2253,2254,2255,2256 (version3 spec) // draft-ietf-asid-ldap-c-api-00.txt (v3 API) // RFC2279 (UTF-8) // // Interesting, applicable // RFC 2307 (LDAP as network information services; draft?) #if constant(.ldap_privates.ldap_der_decode) #include "ldap_globals.h" #include "ldap_errors.h" #if constant(SSL.sslfile) import SSL.constants; #endif #ifdef LDAP_PROTOCOL_PROFILE int _prof_gtim; #endif // ------------------------ // ASN.1 decode macros #define ASN1_DECODE_RESULTAPP(X) (.ldap_privates.ldap_der_decode(X)->elements[1]->get_tag()) #define ASN1_DECODE_RESULTCODE(X) (int)(.ldap_privates.ldap_der_decode(X)->elements[1]->elements[0]->value->cast_to_int()) #define ASN1_DECODE_RESULTSTRING(X) (.ldap_privates.ldap_der_decode(X)->elements[1]->elements[2]->value) #define ASN1_DECODE_RESULTREFS(X) (.ldap_privates.ldap_der_decode(X)->elements[1]->elements[3]->elements) #define ASN1_DECODE_ENTRIES(X) _New_decode(X) #define ASN1_DECODE_DN(X) (string)((X)->elements[0]->value) #define ASN1_DECODE_RAWDEBUG(X) (.ldap_privates.ldap_der_decode(X)->debug_string()) #define ASN1_GET_ATTR_ARRAY(X) (array)((X)->elements[1]->elements) #define ASN1_GET_ATTR_NAME(X) ((X)->elements[0]->value) //! Contains the client implementation of the LDAP protocol. //! All of the version 2 protocol features are implemented //! but only the base parts of the version 3. inherit .protocol; private int binded = 0; // flag for v2 operations private string ldap_basedn = ""; // baseDN private int ldap_scope = 0; // 0: base, 1: onelevel, 2: subtree private int ldap_deref = 0; // 0: ... private int ldap_sizelimit = 0; private int ldap_timelimit = 0; private mapping lauth = ([]); private object last_rv = 0; // last returned value //! Contains the result of a LDAP search. //! //! @seealso //! @[LDAP.client.search], @[LDAP.client.result.fetch] //! class result // ------------------ { private int resultcode = LDAP_SUCCESS; private string resultstring; private int entrycnt = 0; private int actnum = 0; private array(mapping(string:array(string))) entry = ({}); array(string) referrals; private string utf2s(string in) { // catched variant of utf8_to_string needed for tagged octet string data string out = ""; catch( out = utf8_to_string(in) ); return out; } private array _get_attr_values(int ver, object x) { array res = ({}); if(!sizeof(x->elements)) return(res); foreach(x->elements[1]->elements, object val1) res += ({ val1->value }); if(ver == 3) { // deUTF8 res = Array.map(res, utf2s); } return(res); } private array _New_decode(array ar) { array res = ({}); array entry1; mapping attrs; object oder; foreach(ar, string raw1) { oder = (.ldap_privates.ldap_der_decode(raw1)->elements[1]); attrs = (["dn":({ASN1_DECODE_DN(oder)})]); if(catch(entry1 = ASN1_GET_ATTR_ARRAY(oder))) continue; foreach(entry1, object attr1) { attrs += ([ASN1_GET_ATTR_NAME(attr1):_get_attr_values(ldap_version, attr1)]); } res += ({attrs}); } return (res); } // _New_decode //! //! You can't create instances of this object yourself. //! The only way to create it is via a search of a LDAP server. object|int create(array rawres, int|void stuff) { // rawres: array of result in raw format, but WITHOUT LDAP PDU !!! // stuff: 1=bind result; ... int lastel = sizeof(rawres) - 1; if (lastel < 0) { global::seterr (LDAP_LOCAL_ERROR); THROW(({"LDAP: Internal error.\n",backtrace()})); return(-global::ldap_errno); } DWRITE(sprintf("result.create: rawres=%O\n",rawres[lastel])); // The last element of 'rawres' is result itself resultcode = ASN1_DECODE_RESULTCODE(rawres[lastel]); DWRITE(sprintf("result.create: code=%d\n",resultcode)); resultstring = ASN1_DECODE_RESULTSTRING(rawres[lastel]); DWRITE(sprintf("result.create: str=%s\n",resultstring)); #ifdef V3_REFERRALS // referral (v3 mode) if(resultcode == 10) { referrals = ({}); foreach(ASN1_DECODE_RESULTREFS(rawres[lastel]), object ref1) referrals += ({ ref1->value }); DWRITE(sprintf("result.create: refs=%O\n",referrals)); } #endif DWRITE(sprintf("result.create: elements=%d\n",lastel+1)); if (lastel) { // Have we any entry? entry = ASN1_DECODE_ENTRIES(rawres[..lastel-1]); entrycnt = sizeof(entry); //num_entries(); } #if 0 // Context specific proccessing of 'rawres' switch(stuff) { case 1: DWRITE("result.create: stuff=1\n"); break; default: DWRITE(sprintf("result.create: stuff=%d\n", stuff)); } #endif return(this_object()); } //! //! Returns error number of search result. //! //! @seealso //! @[LDAP.client.result.error_string] int error_number() { return(resultcode); } //! //! Returns error description of search result. //! //! @seealso //! @[LDAP.client.result.error_number] string error_string() { return((stringp(resultstring) && sizeof(resultstring)) ? resultstring : ldap_errlist[resultcode]); } //! //! Returns the number of entries. //! //! @seealso //! @[LDAP.client.result.count_entries] int num_entries() { return(entrycnt); } //! //! Returns the number of entries from current cursor //! possition till end of the list. //! //! @seealso //! @[LDAP.client.result.first], @[LDAP.client.result.next] int count_entries() { return(entrycnt - actnum); } //! Returns a mapping with an entry for each attribute. //! Each entry is an array of values of the attribute. //! //! @param index //! Optional argument can be used for direct access //! to the entry other then currently pointed by cursor. int|mapping(string:array(string)) fetch(int|void idx) { if (!idx) idx = actnum + 1; if ((idx <= num_entries()) && (idx > 0)) { actnum = idx - 1; return(entry[actnum]); } return(0); } //! //! Returns distinguished name (DN) of the current entry //! in the result list. Notice that this is the same //! as fetch()->dn[0]. string get_dn() { return(fetch()["dn"][0]); } //! //! Initialized the result cursor to the first entry //! in the result list. //! //! @seealso //! @[LDAP.client.result.next] void first() { actnum = 0; } //! //! Moves the result cursor to the next entry //! in the result list. Returns number of remained entries //! in the result list. Returns 0 at the end. //! //! @seealso //! @[LDAP.client.result.next] int next() { if (actnum < (num_entries()-1)) { actnum++; return(count_entries()); } return(0); } } // end of class 'result' --------------- // helper functions private int chk_ver() { if ((ldap_version != 2) && (ldap_version != 3)) { seterr (LDAP_PROTOCOL_ERROR); THROW(({"LDAP: Unknown/unsupported protocol version.\n",backtrace()})); return(-ldap_errno); } return(0); } private int chk_binded() { // For version 2: we must be 'binded' first !!! if ((ldap_version == 2) && !binded) { seterr (LDAP_PROTOCOL_ERROR); THROW(({"LDAP: Must binded first.\n",backtrace()})); return(-ldap_errno); } if ((ldap_version == 3) && !binded) bind(); return(0); } private int chk_dn(string dn) { if ((!dn) || (!sizeof(dn))) { seterr (LDAP_INVALID_DN_SYNTAX); THROW(({"LDAP: Invalid DN syntax.\n",backtrace()})); return(-ldap_errno); } return(0); } //! Several information about code itself and about active connection too mapping info; //! @decl void create() //! @decl void create(string url) //! @decl void create(string url, object context) //! //! Create object. The first optional argument can be used later //! for subsequence operations. The second one can specify //! TLS context of connection. The default context only allows //! 128-bit encryption methods, so you may need to provide your //! own context if your LDAP server supports only export encryption. //! //! @param url //! LDAP server URL in form //! @tt{"ldap://hostname/basedn?attrlist?scope?ext"@} //! //! @param context //! TLS context of connection //! //! @seealso //! @[LDAP.client.bind], @[LDAP.client.search] void create(string|void url, object|void context) { info = ([ "code_revision" : ("$Revision: 1.46 $"/" ")[1] ]); if(!url || !sizeof(url)) url = LDAP_DEFAULT_URL; lauth = parse_url(url); if(!stringp(lauth->scheme) || ((lauth->scheme != "ldap") #if constant(SSL.sslfile) && (lauth->scheme != "ldaps") #endif )) { THROW(({"Unknown scheme in server URL.\n",backtrace()})); } if(!lauth->host) lauth += ([ "host" : LDAP_DEFAULT_HOST ]); if(!lauth->port) lauth += ([ "port" : lauth->scheme == "ldap" ? LDAP_DEFAULT_PORT : LDAPS_DEFAULT_PORT ]); #if constant(SSL.sslfile) if(lauth->scheme == "ldaps" && !context) { context = SSL.context(); // Allow only strong crypto context->preferred_suites = ({ SSL_rsa_with_idea_cbc_sha, SSL_rsa_with_rc4_128_sha, SSL_rsa_with_rc4_128_md5, SSL_rsa_with_3des_ede_cbc_sha, }); } #endif if(!(::connect(lauth->host, lauth->port))) { //errno = ldapfd->errno(); seterr (LDAP_SERVER_DOWN); DWRITE("client.create: ERROR: can't open socket.\n"); //ldapfd->destroy(); //ldap=0; //ok = 0; //if(con_fail) // con_fail(this_object(), @extra_args); THROW(({"Failed to connect to LDAP server.\n",backtrace()})); } #if constant(SSL.sslfile) if(lauth->scheme == "ldaps") { context->random = Crypto.randomness.reasonably_random()->read; ::create(SSL.sslfile(::_fd, context, 1,1)); info->tls_version = ldapfd->version; } else ::create(::_fd); #else if(lauth->scheme == "ldaps") { THROW(({"LDAP: LDAPS is not available without SSL support.\n",backtrace()})); } else ::create(::_fd); #endif DWRITE("client.create: connected!\n"); DWRITE(sprintf("client.create: remote = %s\n", query_address())); DWRITE_HI("client.OPEN: " + lauth->host + ":" + (string)(lauth->port) + " - OK\n"); binded = 0; if(lauth->scope) set_scope(lauth->scope); if(lauth->basedn) set_basedn(lauth->basedn); } // create private mixed send_bind_op(string name, string password) { // Simple BIND operation object msgval, vers, namedn, auth, app; vers = Standards.ASN1.Types.asn1_integer(ldap_version); namedn = Standards.ASN1.Types.asn1_octet_string(name); auth = ASN1_CONTEXT_OCTET_STRING(0, password); // SASL credentials ommited msgval = ASN1_APPLICATION_SEQUENCE(0, ({vers, namedn, auth})); return (do_op(msgval)); } //! @decl int bind() //! @decl int bind(string dn, string password) //! @decl int bind(string dn, string password, int version) //! //! Authenticates connection to the direcory. //! //! First form uses default value previously entered in create. //! //! Second form uses value from parameters: //! //! @param dn //! The distinguished name (DN) of an entry aginst which will //! be made authentication. //! @param password //! Password used for authentication. //! //! Third form allows specify the version of LDAP protocol used //! by connection to the LDAP server. //! //! @param version //! Only @tt{2@} or @tt{3@} can be entered. //! //! @returns //! Returns @tt{1@} on success, @tt{0@} otherwise. //! //! @note //! Only simple authentication type is implemented. So be warned //! clear text passwords are sent to the directory server. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int bind (string|void dn, string|void password, int|void version) { int id; mixed raw; if (!version) version = LDAP_DEFAULT_VERSION; if (chk_ver()) return(0); if (!stringp(dn)) dn = mappingp(lauth->ext) ? lauth->ext->bindname||"" : ""; if (!stringp(password)) password = ""; ldap_version = version; if(ldap_version == 3) { dn = string_to_utf8(dn); password = string_to_utf8(password); } if(intp(raw = send_bind_op(dn, password))) { THROW(({error_string()+"\n",backtrace()})); return(-ldap_errno); } binded = 0; last_rv = result(({raw}),1); if (!last_rv->error_number()) binded = 1; DWRITE_HI(sprintf("client.BIND: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return binded; } // bind private int send_unbind_op() { // UNBIND operation writemsg(ASN1_APPLICATION_OCTET_STRING(2, "")); //ldap::close(); return (1); } void destroy() { //send_unbind_op(); destruct(this_object()); } //! //! Unbinds from the directory and close the connection. int unbind () { if (send_unbind_op() < 1) { THROW(({error_string()+"\n",backtrace()})); return(-ldap_errno); } binded = 0; DWRITE_HI("client.UNBIND: OK\n"); } // unbind private int|string send_op_withdn(int op, string dn) { // DELETE, ... return (do_op(ASN1_APPLICATION_OCTET_STRING(op, dn))); } //! //! Deletes entry from the LDAP server. //! //! @param dn //! The distinguished name of deleted entry. //! //! @returns //! Returns @tt{1@} on success, @tt{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int delete (string dn) { int id; mixed raw; if (chk_ver()) return(0); if (chk_binded()) return(0); if (chk_dn(dn)) return(0); if(ldap_version == 3) { dn = string_to_utf8(dn); } if(intp(raw = send_op_withdn(10, dn))) { THROW(({error_string()+"\n",backtrace()})); return(0); } last_rv = result(({raw})); DWRITE_HI(sprintf("client.DELETE: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return (!last_rv->error_number()); } // delete private int|string send_compare_op(string dn, array(string) aval) { // COMPARE object msgval; msgval = ASN1_APPLICATION_SEQUENCE(14, ({ Standards.ASN1.Types.asn1_octet_string(dn), Standards.ASN1.Types.asn1_sequence( ({ Standards.ASN1.Types.asn1_octet_string(aval[0]), Standards.ASN1.Types.asn1_octet_string(aval[1]) })) }) ); return (do_op(msgval)); } //! //! Compares given attribute value with one in the directory. //! //! @param dn //! The distinguished name of compared entry. //! //! @param aval //! The mapping of compared attributes and theirs values. //! //! @returns //! Returns @tt{1@} on success, @tt{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int compare (string dn, array(string) aval) { int id; mixed raw; // if (!aval || sizeof(aval)<2) // error if (chk_ver()) return(0); if (chk_binded()) return(0); if (chk_dn(dn)) return(0); if(ldap_version == 3) { dn = string_to_utf8(dn); aval = Array.map(aval, string_to_utf8); } if(intp(raw = send_compare_op(dn, aval))) { THROW(({error_string()+"\n",backtrace()})); return(0); } last_rv = result(({raw})); DWRITE_HI(sprintf("client.COMPARE: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return (!last_rv->error_number()); } // compare private int|string send_add_op(string dn, mapping(string:array(string)) attrs) { // ADD object msgval; string atype; array(object) oatt = ({}); foreach(indices(attrs), atype) { string aval; array(object) ohlp = ({}); foreach(values(attrs[atype]), aval) ohlp += ({Standards.ASN1.Types.asn1_octet_string(aval)}); oatt += ({Standards.ASN1.Types.asn1_sequence( ({Standards.ASN1.Types.asn1_octet_string(atype), Standards.ASN1.Types.asn1_set(ohlp) })) }); } msgval = ASN1_APPLICATION_SEQUENCE(8, ({Standards.ASN1.Types.asn1_octet_string(dn), Standards.ASN1.Types.asn1_sequence(oatt) })); return (do_op(msgval)); } //! The Add Operation allows a client to request the addition //! of an entry into the directory //! //! @param dn //! The Distinguished Name of the entry to be added. //! //! @param attrs //! The mapping of attributes and their values that make up the content //! of the entry being added. //! //! @returns //! Returns @tt{1@} on success, @tt{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int add (string dn, mapping(string:array(string)) attrs) { int id; mixed raw; if (chk_ver()) return(0); if (chk_binded()) return(0); if (chk_dn(dn)) return(0); if(ldap_version == 3) { dn = string_to_utf8(dn); array(string) keys = indices(attrs); array(array(string)) vals = values(attrs); attrs = mkmapping(Array.map(keys, string_to_utf8), Array.map(vals, Array.map, string_to_utf8)); } if(intp(raw = send_add_op(dn, attrs))) { THROW(({error_string()+"\n",backtrace()})); return(0); } last_rv = result(({raw})); DWRITE_HI(sprintf("client.ADD: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return (!last_rv->error_number()); } // add private static array(string) filter_get_sub1expr(string fstr) { // returns one-level brackets enclosed expressions array(string) rvarr = ({}); int leftflg = 0, nskip = 0; for(int ix=0; ix<sizeof(fstr); ix++) if((fstr[ix] == '(') && (!ix || (fstr[ix-1] != '\\'))) { leftflg = ix+1; while(++ix < sizeof(fstr)) { if((fstr[ix] == '(') && (fstr[ix-1] != '\\')) { nskip++; // deeper expr. continue; } if((fstr[ix] == ')') && (fstr[ix-1] != '\\')) if(nskip) { // we are deeply? nskip--; continue; } else { // ok, here is end of expr. rvarr += ({fstr[leftflg..(ix-1)]}); leftflg = 0; break; } } // while } if(leftflg) { ; // silent error: Missed right-enclosed bracket ! } //DWRITE(sprintf("client.sub1: arr=%O\n",rvarr)); return(rvarr); } /*private*/ object make_simple_filter(string filter) { // filter expression parser - only simple expressions! object rv; int op, ix; DWRITE(sprintf("client.make_simple_filter: filter: [%s]\n", filter)); if((op = predef::search(filter, ">=")) > 0) { // greater or equal DWRITE("client.make_simple_filter: [>=]\n"); return(ASN1_CONTEXT_SEQUENCE(5, ({Standards.ASN1.Types.asn1_octet_string(filter[..(op-1)]), Standards.ASN1.Types.asn1_octet_string(filter[(op+2)..]) }))); } if((op = predef::search(filter, "<=")) > 0) { // less or equal DWRITE("client.make_simple_filter: [<=]\n"); return(ASN1_CONTEXT_SEQUENCE(6, ({Standards.ASN1.Types.asn1_octet_string(filter[..(op-1)]), Standards.ASN1.Types.asn1_octet_string(filter[(op+2)..]) }))); } if((op = predef::search(filter, "=")) > 0) { // equal, substring if((filter[-2] == '=') && (filter[-1] == '*')) // any (=*) return(make_simple_filter(filter[..op-1])); ix = predef::search(filter[(op+1)..], "*"); if ((ix != -1) && (filter[op+ix] != '\\')) { // substring object ohlp; array oarr = ({}), ahlp = ({}); array filtval = filter[(op+1)..] / "*"; // escape processing for(int cnt = 0; cnt < sizeof(filtval); cnt++) { if(cnt) { if(sizeof(filtval[cnt-1]) && filtval[cnt-1][-1] == '\\') ahlp[-1] = reverse(reverse(ahlp[-1])[1..]) + filtval[cnt]; else ahlp += ({ filtval[cnt] }); } else ahlp = ({ filtval[cnt] }); } // for // filter elements processing (left, center & right) ix = sizeof(ahlp); for (int cnt = 0; cnt < ix; cnt++) if(!cnt) { // leftmost element if(sizeof(ahlp[0])) oarr = ({ASN1_CONTEXT_OCTET_STRING(0, ahlp[0])}); } else if(cnt == ix-1) { // rightmost element if(sizeof(ahlp[ix-1])) oarr += ({ASN1_CONTEXT_OCTET_STRING(2, ahlp[ix-1])}); } else { // inside element if(sizeof(ahlp[cnt])) oarr += ({ASN1_CONTEXT_OCTET_STRING(1, ahlp[cnt])}); } // for DWRITE(sprintf("client.make_simple_filter: substring: [%s]:\n%O\n", filter, ahlp)); return(ASN1_CONTEXT_SEQUENCE(4, ({Standards.ASN1.Types.asn1_octet_string(filter[..(op-1)]), Standards.ASN1.Types.asn1_sequence(oarr) }))); } else { // equal DWRITE("client.make_simple_filter: [=]\n"); return(ASN1_CONTEXT_SEQUENCE(3, ({Standards.ASN1.Types.asn1_octet_string(filter[..(op-1)]), Standards.ASN1.Types.asn1_octet_string(filter[(op+1)..]) }))); } } // if equal,substring // present DWRITE("client.make_simple_filter: [present]\n"); return(ASN1_CONTEXT_OCTET_STRING(7, filter)); } /*private*/ object|int make_filter(string filter) { // filter expression parser object ohlp; array(object) oarr = ({}); int op ; DWRITE("client.make_filter: filter=["+filter+"]\n"); if (!sizeof(filter)) return make_simple_filter(filter); // strip leading and trailing spaces filter = String.trim_all_whites(filter); // strip leading and trailing brackets #if 1 if(filter[0] == '(') { int ix; string f2 = reverse(filter[1..]); if((ix = predef::search(f2, ")")) > -1) { filter = reverse(f2[ix+1..]); return(make_filter(filter)); } return(-1); // error in filter expr. } #endif op = -1; DWRITE(sprintf("client.make_filter: ftype=%c\n",filter[0])); switch (filter[0]) { case '&': // and case '|': // or foreach(filter_get_sub1expr(filter[1..]), string sub1expr) if (objectp(ohlp = make_filter(sub1expr))) oarr += ({ohlp}); else return(0); // error: Filter parameter error! DWRITE(sprintf("client.make_filter: expr_cnt=%d\n",sizeof(oarr))); //ohlp = Standards.ASN1.Encode.asn1_set(@oarr); op = 0; if (filter[0] == '|') op = 1; return(ASN1_CONTEXT_SET(op, oarr)); case '!': // not if (objectp(ohlp = make_filter(filter_get_sub1expr(filter[1..])[0]))) return(ASN1_CONTEXT_SEQUENCE(2, ({ ohlp}) )); else return(0); // error: Filter parameter error! break; default : // we assume simple filter return(make_simple_filter(filter)); } } private int|string send_search_op(string basedn, int scope, int deref, int sizelimit, int timelimit, int attrsonly, string filter, void|array(string) attrs){ // SEARCH // limitations: !!! sizelimit and timelimit should be unsigned int !!! object msgval, ofilt; array(object) ohlp; if(!objectp(ofilt = make_filter(filter))) { return(-seterr(LDAP_FILTER_ERROR)); } ohlp = ({ofilt}); if (arrayp(attrs)) { //explicitly defined attributes array(object) o2 = ({}); foreach(attrs, string s2) o2 += ({Standards.ASN1.Types.asn1_octet_string(s2)}); ohlp += ({Standards.ASN1.Types.asn1_sequence(o2)}); } else ohlp += ({Standards.ASN1.Types.asn1_sequence(({}))}); msgval = ASN1_APPLICATION_SEQUENCE(3, ({ Standards.ASN1.Types.asn1_octet_string(basedn), ASN1_ENUMERATED(scope), ASN1_ENUMERATED(deref), Standards.ASN1.Types.asn1_integer(sizelimit), Standards.ASN1.Types.asn1_integer(timelimit), ASN1_BOOLEAN(attrsonly ? -1 : 0), @ohlp })) ; return (do_op(msgval)); } //! Search LDAP directory. //! //! @param filter //! Search filter used when searching directory objects. //! //! @param attrs //! The array of attribute names which will be returned by server. //! for every entry. //! //! @param attrsonly //! The flag causes server return only attribute name but not //! the attribute values. //! //! @returns //! Returns object @[LDAP.client.result] on success, @tt{0@} //! otherwise. //! //! @note //! For syntax of search filter see at RFC 1960 //! (http://community.roxen.com/developers/idocs/rfc/rfc1960.html). //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. //! //! @seealso //! @[LDAP.client.result], @[LDAP.client.result.fetch] object|int search (string|void filter, array(string)|void attrs, int|void attrsonly) { int id,nv; mixed raw; array(string) rawarr = ({}); filter=filter||lauth->filter; // default from LDAP URI DWRITE_HI("client.SEARCH: " + (string)filter + "\n"); if (chk_ver()) return(0); if (chk_binded()) return(0); if(ldap_version == 3) { filter = string_to_utf8(filter); } #ifdef LDAP_PROTOCOL_PROFILE _prof_gtim = gauge{ #endif if(intp(raw = send_search_op(ldap_basedn, ldap_scope, ldap_deref, ldap_sizelimit, ldap_timelimit, attrsonly, filter, attrs||lauth->attributes))) { THROW(({error_string()+"\n",backtrace()})); return(0); } #ifdef LDAP_PROTOCOL_PROFILE }; DWRITE_PROF("send_search_op: %O\n", _prof_gtim); #endif rawarr = ({raw}); #ifdef LDAP_PROTOCOL_PROFILE _prof_gtim = gauge{ #endif while (ASN1_DECODE_RESULTAPP(raw) != 5) { #ifdef LDAP_PROTOCOL_PROFILEx DWRITE_PROF("readmsg: %O\n", gauge { raw = readmsg(id); }); #else raw = readmsg(id); #endif if (intp(raw)) { THROW(({error_string()+"\n",backtrace()})); return(0); } rawarr += ({raw}); } // while #ifdef LDAP_PROTOCOL_PROFILE }; DWRITE_PROF("rawarr++: %O\n", _prof_gtim); #endif #ifdef LDAP_PROTOCOL_PROFILE _prof_gtim = gauge{ last_rv = result(rawarr); }; DWRITE_PROF("result: %O\n", _prof_gtim); #else last_rv = result(rawarr); #endif if(objectp(last_rv)) seterr (last_rv->error_number()); //if (rv->error_number() || !rv->num_entries()) // if error or entries=0 // rv = rv->error_number(); DWRITE_HI(sprintf("client.SEARCH: %s (entries: %d)\n", last_rv->error_string(), last_rv->num_entries())); return(last_rv); } // search //! @param base_dn //! base DN for search string set_basedn (string base_dn) { string old_dn = ldap_basedn; if(ldap_version == 3) { base_dn = string_to_utf8(base_dn); } ldap_basedn = base_dn; DWRITE_HI("client.SET_BASEDN = " + base_dn + "\n"); return(old_dn); } //! //! Sets value of scope for search operation. //! //! @param scope //! Value can be integer or its corresponding string value. //! 0: base, 1: one, 2: sub //! int set_scope (int|string scope) { int old_scope = ldap_scope; // support for string based values if(stringp(scope)) switch (lower_case(scope)) { case "sub": scope = 2; break; case "one": scope = 1; break; case "base": scope = 0; break; default: return (-1); } else if(scope != 0 && scope != 1 && scope != 2) return (-1); ldap_scope = scope; DWRITE_HI("client.SET_SCOPE = " + (string)scope + "\n"); return(old_scope); } //! @param option_type //! LDAP_OPT_xxx //! @param value //! new value for option int set_option (int opttype, int value) { DWRITE_HI("client.SET_OPTION: " + (string)opttype + " = " + (string)value + "\n"); switch (opttype) { case 1: // LDAP_OPT_DEREF //if (intp(value)) ldap_deref = value; //else // return(-1); break; case 2: // LDAP_OPT_SIZELIMIT //if (intp(value)) ldap_sizelimit = value; //else // return(-1); break; case 3: // LDAP_OPT_TIMELIMIT //if (intp(value)) ldap_timelimit = value; //else // return(-1); break; case 4: // LDAP_OPT_REFERRALS default: return(-1); } return(0); } //! @param option_type //! LDAP_OPT_xxx int get_option (int opttype) { DWRITE_HI("client.GET_OPTION: " + (string)opttype + "\n"); switch (opttype) { case 1: // LDAP_OPT_DEREF return(ldap_deref); case 2: // LDAP_OPT_SIZELIMIT return(ldap_sizelimit); case 3: // LDAP_OPT_TIMELIMIT return(ldap_timelimit); case 4: // LDAP_OPT_REFERRALS } return(-1); } private int|string send_modify_op(string dn, mapping(string:array(mixed)) attropval) { // MODIFY object o, msgval; string atype; array(object) oatt = ({}), attrarr; foreach(indices(attropval), atype) { if(!intp((attropval[atype])[0])) return(seterr (LDAP_PROTOCOL_ERROR)); attrarr = ({}); for(int ix=1; ix<sizeof(attropval[atype]); ix++) attrarr += ({Standards.ASN1.Types.asn1_octet_string( (attropval[atype])[ix])}); // if(sizeof(attrarr)) // attributevalue ? o = Standards.ASN1.Types.asn1_sequence( ({Standards.ASN1.Types.asn1_octet_string(atype), Standards.ASN1.Types.asn1_set(attrarr) })); // else // o = Standards.ASN1.Encode.asn1_sequence( // Standards.ASN1.Encode.asn1_octet_string(atype)); oatt += ({Standards.ASN1.Types.asn1_sequence( ({ASN1_ENUMERATED((attropval[atype])[0]), o }))}); } //foreach msgval = ASN1_APPLICATION_SEQUENCE(6, ({ Standards.ASN1.Types.asn1_octet_string(dn), Standards.ASN1.Types.asn1_sequence(oatt) })); return (do_op(msgval)); } private int|string send_modifydn_op(string dn, string newrdn, int deleteoldrdn, string newsuperior) { object msgval; array seq=({ Standards.ASN1.Types.asn1_octet_string(dn), Standards.ASN1.Types.asn1_octet_string(newrdn), Standards.ASN1.Types.asn1_boolean(deleteoldrdn) }); if(newsuperior) seq+=({Standards.ASN1.Types.asn1_octet_string(newsuperior)}); msgval = ASN1_APPLICATION_SEQUENCE(12, seq); return (do_op(msgval)); } //! The Modify DN Operation allows a client to change the leftmost //! (least significant) component of the name of an entry in the directory, //! or to move a subtree of entries to a new location in the directory. //! //! @param dn //! DN of source object //! //! @param newrdn //! RDN of destination //! //! @param deleteoldrdn //! The parameter controls whether the old RDN attribute values //! are to be retained as attributes of the entry, or deleted //! from the entry. //! //! @param newsuperior //! If present, this is the Distinguished Name of the entry //! which becomes the immediate superior of the existing entry. //! //! @returns //! Returns @tt{1@} on success, @tt{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int modifydn (string dn, string newrdn, int deleteoldrdn, string|void newsuperior) { mixed raw; if (chk_ver()) return(0); if (chk_binded()) return(0); if (chk_dn(dn)) return(0); if(ldap_version == 3) { dn = string_to_utf8(dn); newrdn = string_to_utf8(newrdn); if(newsuperior) newsuperior = string_to_utf8(newsuperior); } if(intp(raw = send_modifydn_op(dn, newrdn, deleteoldrdn, newsuperior))) { THROW(({error_string()+"\n",backtrace()})); return(0); } last_rv = result(({raw})); DWRITE_HI(sprintf("client.MODIFYDN: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return (!last_rv->error_number()); } //modifydn //! The Modify Operation allows a client to request that a modification //! of an entry be performed on its behalf by a server. //! //! @param dn //! The distinguished name of modified entry. //! //! @param attropval //! The mapping of attributes with requested operation and attribute's //! values. //! //! attropval=([ attribute: ({operation, value1, value2, ...}) ]) //! //! where operation is one of the following: //! 0 (LDAP_OPERATION_ADD) - //! add values listed to the given attribute, creating the attribute //! if necessary //! 1 (LDAP_OPERATION_DELETE) - //! delete values listed from the given attribute, removing the entire //! attribute if no values are listed, or if all current values //! of the attribute are listed for deletion //! 2 (LDAP_OPERATION_REPLACE) - //! replace all existing values of the given attribute with the new //! values listed, creating the attribute if it did not already exist. //! A replace with no value will delete the entire attribute if it //! exists, and is ignored if the attribute does not exist //! //! @returns //! Returns @tt{1@} on uccess, @tt{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ //! to follow his logic better. int modify (string dn, mapping(string:array(mixed)) attropval) { int id; mixed raw; if (chk_ver()) return(0); if (chk_binded()) return(0); if (chk_dn(dn)) return(0); if(ldap_version == 3) { dn = string_to_utf8(dn); array(string) keys = indices(attropval); array(array(mixed)) vals = values(attropval); attropval = mkmapping(Array.map(keys, string_to_utf8), Array.map(vals, Array.map, lambda(mixed x) { return (stringp(x)? string_to_utf8(x) : x); })); } if(intp(raw = send_modify_op(dn, attropval))) { THROW(({error_string()+"\n",backtrace()})); return(0); } last_rv = result(({raw})); DWRITE_HI(sprintf("client.MODIFY: %s\n", last_rv->error_string())); seterr (last_rv->error_number()); return (!last_rv->error_number()); } // modify //! Gets referrals. //! //! @returns //! Returns array of referrals or @tt{0@}. array|int get_referrals() { if(last_rv->referrals) return last_rv->referrals; return 0; } //! @param ldapuri //! LDAP URL mapping|int parse_url (string ldapuri) { // ldap://machine.at.home.cz:123/c=cz?attr1,attr2,attr3?sub?(uid=*)?!bindname=uid=hop,dc=unibase,dc=cz" string url=ldapuri, s, scheme; array ar; mapping res; s = (url / ":")[0]; url = url[sizeof(s)..]; res = ([ "scheme" : s ]); #ifdef LDAP_URL_STRICT if (url[..2] != "://") return(-1); #endif s = (url[3..] / "/")[0]; url = url[sizeof(s)+4..]; res += ([ "host" : (s / ":")[0] ]); if(sizeof(s / ":") > 1) res += ([ "port" : (int)((s / ":")[1]) ]); ar = url / "?"; switch (sizeof(ar)) { case 5: if (sizeof(ar[4])) { mapping extensions = ([]); foreach(ar[4] / ",", string ext) { int ix = predef::search(ext, "="); if(ix) extensions += ([ ext[..(ix-1)] : replace(ext[ix+1..],QUOTED_COMMA, ",") ]); } if (sizeof(extensions)) res += ([ "ext" : extensions ]); } //case 5: res += ([ "ext" : ar[4] ]); case 4: res += ([ "filter" : ar[3] ]); case 3: switch (ar[2]) { case "sub": res += ([ "scope" : 2 ]); break; case "one": res += ([ "scope" : 1 ]); break; default: res += ([ "scope" : 0]); // = "base" } case 2: res += sizeof(ar[1]) ? ([ "attributes" : ar[1] / "," ]) : ([]); case 1: res += ([ "basedn" : ar[0] ]); } return (res); } //parse_uri #endif

pike.git/ lib/ modules/ Protocols.pmod/ LDAP.pmod/ client.pike > e254441b0fe0c6188fe2a2e6b6e2e92ca11780c8 [Annotate]