s3-libsmb: introduce new cli_query_secdesc() which returns NTSTATUS
[Samba.git] / source3 / include / ads.h
blob8a8ce28e5305dd7fc80f01e23b396dba7afdb3b5
1 #ifndef _INCLUDE_ADS_H_
2 #define _INCLUDE_ADS_H_
3 /*
4 header for ads (active directory) library routines
6 basically this is a wrapper around ldap
7 */
9 #include "libads/ads_status.h"
10 #include "smb_ldap.h"
12 struct ads_struct;
14 struct ads_saslwrap_ops {
15 const char *name;
16 ADS_STATUS (*wrap)(struct ads_struct *, uint8 *buf, uint32 len);
17 ADS_STATUS (*unwrap)(struct ads_struct *);
18 void (*disconnect)(struct ads_struct *);
21 enum ads_saslwrap_type {
22 ADS_SASLWRAP_TYPE_PLAIN = 1,
23 ADS_SASLWRAP_TYPE_SIGN = 2,
24 ADS_SASLWRAP_TYPE_SEAL = 4
27 typedef struct ads_struct {
28 int is_mine; /* do I own this structure's memory? */
30 /* info needed to find the server */
31 struct {
32 char *realm;
33 char *workgroup;
34 char *ldap_server;
35 int foreign; /* set to 1 if connecting to a foreign
36 * realm */
37 bool gc; /* Is this a global catalog server? */
38 } server;
40 /* info needed to authenticate */
41 struct {
42 char *realm;
43 char *password;
44 char *user_name;
45 char *kdc_server;
46 unsigned flags;
47 int time_offset;
48 time_t tgt_expire;
49 time_t tgs_expire;
50 time_t renewable;
51 } auth;
53 /* info derived from the servers config */
54 struct {
55 uint32 flags; /* cldap flags identifying the services. */
56 char *realm;
57 char *bind_path;
58 char *ldap_server_name;
59 char *server_site_name;
60 char *client_site_name;
61 time_t current_time;
62 char *schema_path;
63 char *config_path;
64 } config;
66 /* info about the current LDAP connection */
67 #ifdef HAVE_LDAP
68 struct {
69 LDAP *ld;
70 struct sockaddr_storage ss; /* the ip of the active connection, if any */
71 time_t last_attempt; /* last attempt to reconnect, monotonic clock */
72 int port;
74 enum ads_saslwrap_type wrap_type;
76 #ifdef HAVE_LDAP_SASL_WRAPPING
77 Sockbuf_IO_Desc *sbiod; /* lowlevel state for LDAP wrapping */
78 #endif /* HAVE_LDAP_SASL_WRAPPING */
79 TALLOC_CTX *mem_ctx;
80 const struct ads_saslwrap_ops *wrap_ops;
81 void *wrap_private_data;
82 struct {
83 uint32 ofs;
84 uint32 needed;
85 uint32 left;
86 #define ADS_SASL_WRAPPING_IN_MAX_WRAPPED 0x0FFFFFFF
87 uint32 max_wrapped;
88 uint32 min_wrapped;
89 uint32 size;
90 uint8 *buf;
91 } in;
92 struct {
93 uint32 ofs;
94 uint32 left;
95 #define ADS_SASL_WRAPPING_OUT_MAX_WRAPPED 0x00A00000
96 uint32 max_unwrapped;
97 uint32 sig_size;
98 uint32 size;
99 uint8 *buf;
100 } out;
101 } ldap;
102 #endif /* HAVE_LDAP */
103 } ADS_STRUCT;
105 #ifdef HAVE_ADS
106 typedef LDAPMod **ADS_MODLIST;
107 #else
108 typedef void **ADS_MODLIST;
109 #endif
111 /* time between reconnect attempts */
112 #define ADS_RECONNECT_TIME 5
114 /* ldap control oids */
115 #define ADS_PAGE_CTL_OID "1.2.840.113556.1.4.319"
116 #define ADS_NO_REFERRALS_OID "1.2.840.113556.1.4.1339"
117 #define ADS_SERVER_SORT_OID "1.2.840.113556.1.4.473"
118 #define ADS_PERMIT_MODIFY_OID "1.2.840.113556.1.4.1413"
119 #define ADS_ASQ_OID "1.2.840.113556.1.4.1504"
120 #define ADS_EXTENDED_DN_OID "1.2.840.113556.1.4.529"
121 #define ADS_SD_FLAGS_OID "1.2.840.113556.1.4.801"
123 /* ldap bitwise searches */
124 #define ADS_LDAP_MATCHING_RULE_BIT_AND "1.2.840.113556.1.4.803"
125 #define ADS_LDAP_MATCHING_RULE_BIT_OR "1.2.840.113556.1.4.804"
127 #define ADS_PINGS 0x0000FFFF /* Ping response */
129 /* ads auth control flags */
130 #define ADS_AUTH_DISABLE_KERBEROS 0x0001
131 #define ADS_AUTH_NO_BIND 0x0002
132 #define ADS_AUTH_ANON_BIND 0x0004
133 #define ADS_AUTH_SIMPLE_BIND 0x0008
134 #define ADS_AUTH_ALLOW_NTLMSSP 0x0010
135 #define ADS_AUTH_SASL_SIGN 0x0020
136 #define ADS_AUTH_SASL_SEAL 0x0040
137 #define ADS_AUTH_SASL_FORCE 0x0080
138 #define ADS_AUTH_USER_CREDS 0x0100
140 enum ads_extended_dn_flags {
141 ADS_EXTENDED_DN_HEX_STRING = 0,
142 ADS_EXTENDED_DN_STRING = 1 /* not supported on win2k */
145 /* this is probably not very well suited to pass other controls generically but
146 * is good enough for the extended dn control where it is only used for atm */
148 typedef struct {
149 const char *control;
150 int val;
151 int critical;
152 } ads_control;
154 #include "libads/ads_proto.h"
156 #ifdef HAVE_LDAP
157 #include "libads/ads_ldap_protos.h"
158 #endif
160 #include "libads/kerberos_proto.h"
162 #endif /* _INCLUDE_ADS_H_ */