source3/winbindd/winbindd.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Winbind daemon for ntdom nss module
   5
   6    Copyright (C) Tim Potter 2000
   7    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
   8
   9    This library is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU Lesser General Public
  11    License as published by the Free Software Foundation; either
  12    version 3 of the License, or (at your option) any later version.
  13
  14    This library is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17    Library General Public License for more details.
  18
  19    You should have received a copy of the GNU Lesser General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _WINBINDD_H
  24 #define _WINBINDD_H
  25
  26 #include "nsswitch/winbind_struct_protocol.h"
  27 #include "nsswitch/libwbclient/wbclient.h"
  28 #include "librpc/gen_ndr/wbint.h"
  29
  30 #include "talloc_dict.h"
  31
  32 #include "../lib/util/tevent_ntstatus.h"
  33
  34 #ifdef HAVE_LIBNSCD
  35 #include <libnscd.h>
  36 #endif
  37
  38 #ifdef HAVE_SYS_MMAN_H
  39 #include <sys/mman.h>
  40 #endif
  41
  42 #undef DBGC_CLASS
  43 #define DBGC_CLASS DBGC_WINBIND
  44
  45 #define WB_REPLACE_CHAR         '_'
  46
  47 struct sid_ctr {
  48         struct dom_sid *sid;
  49         bool finished;
  50         const char *domain;
  51         const char *name;
  52         enum lsa_SidType type;
  53 };
  54
  55 struct winbindd_cli_state {
  56         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
  57         int sock;                                 /* Open socket from client */
  58         pid_t pid;                                /* pid of client */
  59         time_t last_access;                       /* Time of last access (read or write) */
  60         bool privileged;                           /* Is the client 'privileged' */
  61
  62         TALLOC_CTX *mem_ctx;                      /* memory per request */
  63         const char *cmd_name;
  64         NTSTATUS (*recv_fn)(struct tevent_req *req,
  65                             struct winbindd_response *presp);
  66         struct winbindd_request *request;         /* Request from client */
  67         struct tevent_queue *out_queue;
  68         struct winbindd_response *response;        /* Respose to client */
  69         bool getpwent_initialized;                /* Has getpwent_state been
  70                                                    * initialized? */
  71         bool getgrent_initialized;                /* Has getgrent_state been
  72                                                    * initialized? */
  73
  74         struct getpwent_state *pwent_state; /* State for getpwent() */
  75         struct getgrent_state *grent_state; /* State for getgrent() */
  76 };
  77
  78 struct getpwent_state {
  79         struct winbindd_domain *domain;
  80         int next_user;
  81         int num_users;
  82         struct wbint_userinfo *users;
  83 };
  84
  85 struct getgrent_state {
  86         struct winbindd_domain *domain;
  87         int next_group;
  88         int num_groups;
  89         struct wbint_Principal *groups;
  90 };
  91
  92 /* Storage for cached getpwent() user entries */
  93
  94 struct getpwent_user {
  95         fstring name;                        /* Account name */
  96         fstring gecos;                       /* User information */
  97         fstring homedir;                     /* User Home Directory */
  98         fstring shell;                       /* User Login Shell */
  99         struct dom_sid user_sid;                    /* NT user and primary group SIDs */
 100         struct dom_sid group_sid;
 101 };
 102
 103 /* Our connection to the DC */
 104
 105 struct winbindd_cm_conn {
 106         struct cli_state *cli;
 107
 108         struct rpc_pipe_client *samr_pipe;
 109         struct policy_handle sam_connect_handle, sam_domain_handle;
 110
 111         struct rpc_pipe_client *lsa_pipe;
 112         struct rpc_pipe_client *lsa_pipe_tcp;
 113         struct policy_handle lsa_policy;
 114
 115         struct rpc_pipe_client *netlogon_pipe;
 116 };
 117
 118 /* Async child */
 119
 120 struct winbindd_domain;
 121
 122 struct winbindd_child_dispatch_table {
 123         const char *name;
 124         enum winbindd_cmd struct_cmd;
 125         enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
 126                                           struct winbindd_cli_state *state);
 127 };
 128
 129 struct winbindd_child {
 130         struct winbindd_child *next, *prev;
 131
 132         pid_t pid;
 133         struct winbindd_domain *domain;
 134         char *logfilename;
 135
 136         int sock;
 137         struct tevent_queue *queue;
 138         struct dcerpc_binding_handle *binding_handle;
 139
 140         struct timed_event *lockout_policy_event;
 141         struct timed_event *machine_password_change_event;
 142
 143         const struct winbindd_child_dispatch_table *table;
 144 };
 145
 146 /* Structures to hold per domain information */
 147
 148 struct winbindd_domain {
 149         fstring name;                          /* Domain name (NetBIOS) */
 150         fstring alt_name;                      /* alt Domain name, if any (FQDN for ADS) */
 151         fstring forest_name;                   /* Name of the AD forest we're in */
 152         struct dom_sid sid;                           /* SID for this domain */
 153         uint32 domain_flags;                   /* Domain flags from netlogon.h */
 154         uint32 domain_type;                    /* Domain type from netlogon.h */
 155         uint32 domain_trust_attribs;           /* Trust attribs from netlogon.h */
 156         bool initialized;                      /* Did we already ask for the domain mode? */
 157         bool native_mode;                      /* is this a win2k domain in native mode ? */
 158         bool active_directory;                 /* is this a win2k active directory ? */
 159         bool primary;                          /* is this our primary domain ? */
 160         bool internal;                         /* BUILTIN and member SAM */
 161         bool online;                           /* is this domain available ? */
 162         time_t startup_time;                   /* When we set "startup" true. monotonic clock */
 163         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
 164
 165         bool can_do_samlogon_ex; /* Due to the lack of finer control what type
 166                                   * of DC we have, let us try to do a
 167                                   * credential-chain less samlogon_ex call
 168                                   * with AD and schannel. If this fails with
 169                                   * DCERPC_FAULT_OP_RNG_ERROR, then set this
 170                                   * to False. This variable is around so that
 171                                   * we don't have to try _ex every time. */
 172
 173         bool can_do_ncacn_ip_tcp;
 174         bool can_do_validation6;
 175
 176         /* Lookup methods for this domain (LDAP or RPC) */
 177         struct winbindd_methods *methods;
 178
 179         /* the backend methods are used by the cache layer to find the right
 180            backend */
 181         struct winbindd_methods *backend;
 182
 183         /* Private data for the backends (used for connection cache) */
 184
 185         void *private_data;
 186
 187         /*
 188          * idmap config settings, used to tell the idmap child which
 189          * special domain config to use for a mapping
 190          */
 191         bool have_idmap_config;
 192         uint32_t id_range_low, id_range_high;
 193
 194         /* A working DC */
 195         pid_t dc_probe_pid; /* Child we're using to detect the DC. */
 196         fstring dcname;
 197         struct sockaddr_storage dcaddr;
 198
 199         /* Sequence number stuff */
 200
 201         time_t last_seq_check;
 202         uint32 sequence_number;
 203         NTSTATUS last_status;
 204
 205         /* The smb connection */
 206
 207         struct winbindd_cm_conn conn;
 208
 209         /* The child pid we're talking to */
 210
 211         struct winbindd_child *children;
 212
 213         /* Callback we use to try put us back online. */
 214
 215         uint32 check_online_timeout;
 216         struct timed_event *check_online_event;
 217
 218         /* Linked list info */
 219
 220         struct winbindd_domain *prev, *next;
 221 };
 222
 223 struct wb_acct_info {
 224         fstring acct_name; /* account name */
 225         fstring acct_desc; /* account name */
 226         uint32_t rid; /* domain-relative RID */
 227 };
 228
 229 /* per-domain methods. This is how LDAP vs RPC is selected
 230  */
 231 struct winbindd_methods {
 232         /* does this backend provide a consistent view of the data? (ie. is the primary group
 233            always correct) */
 234         bool consistent;
 235
 236         /* get a list of users, returning a wbint_userinfo for each one */
 237         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 238                                    TALLOC_CTX *mem_ctx,
 239                                    uint32 *num_entries,
 240                                    struct wbint_userinfo **info);
 241
 242         /* get a list of domain groups */
 243         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 244                                     TALLOC_CTX *mem_ctx,
 245                                     uint32 *num_entries,
 246                                     struct wb_acct_info **info);
 247
 248         /* get a list of domain local groups */
 249         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 250                                     TALLOC_CTX *mem_ctx,
 251                                     uint32 *num_entries,
 252                                     struct wb_acct_info **info);
 253
 254         /* convert one user or group name to a sid */
 255         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 256                                 TALLOC_CTX *mem_ctx,
 257                                 const char *domain_name,
 258                                 const char *name,
 259                                 uint32_t flags,
 260                                 struct dom_sid *sid,
 261                                 enum lsa_SidType *type);
 262
 263         /* convert a sid to a user or group name */
 264         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 265                                 TALLOC_CTX *mem_ctx,
 266                                 const struct dom_sid *sid,
 267                                 char **domain_name,
 268                                 char **name,
 269                                 enum lsa_SidType *type);
 270
 271         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
 272                                   TALLOC_CTX *mem_ctx,
 273                                   const struct dom_sid *domain_sid,
 274                                   uint32 *rids,
 275                                   size_t num_rids,
 276                                   char **domain_name,
 277                                   char ***names,
 278                                   enum lsa_SidType **types);
 279
 280         /* lookup user info for a given SID */
 281         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 282                                TALLOC_CTX *mem_ctx,
 283                                const struct dom_sid *user_sid,
 284                                struct wbint_userinfo *user_info);
 285
 286         /* lookup all groups that a user is a member of. The backend
 287            can also choose to lookup by username or rid for this
 288            function */
 289         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 290                                       TALLOC_CTX *mem_ctx,
 291                                       const struct dom_sid *user_sid,
 292                                       uint32 *num_groups, struct dom_sid **user_gids);
 293
 294         /* Lookup all aliases that the sids delivered are member of. This is
 295          * to implement 'domain local groups' correctly */
 296         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
 297                                        TALLOC_CTX *mem_ctx,
 298                                        uint32 num_sids,
 299                                        const struct dom_sid *sids,
 300                                        uint32 *num_aliases,
 301                                        uint32 **alias_rids);
 302
 303         /* find all members of the group with the specified group_rid */
 304         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 305                                     TALLOC_CTX *mem_ctx,
 306                                     const struct dom_sid *group_sid,
 307                                     enum lsa_SidType type,
 308                                     uint32 *num_names,
 309                                     struct dom_sid **sid_mem, char ***names,
 310                                     uint32 **name_types);
 311
 312         /* return the current global sequence number */
 313         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
 314
 315         /* return the lockout policy */
 316         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
 317                                    TALLOC_CTX *mem_ctx,
 318                                    struct samr_DomInfo12 *lockout_policy);
 319
 320         /* return the lockout policy */
 321         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
 322                                     TALLOC_CTX *mem_ctx,
 323                                     struct samr_DomInfo1 *password_policy);
 324
 325         /* enumerate trusted domains */
 326         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
 327                                     TALLOC_CTX *mem_ctx,
 328                                     struct netr_DomainTrustList *trusts);
 329 };
 330
 331 /* Filled out by IDMAP backends */
 332 struct winbindd_idmap_methods {
 333   /* Called when backend is first loaded */
 334   bool (*init)(void);
 335
 336   bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
 337   bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
 338
 339   bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
 340   bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
 341
 342   /* Called when backend is unloaded */
 343   bool (*close)(void);
 344   /* Called to dump backend status */
 345   void (*status)(void);
 346 };
 347
 348 /* Data structures for dealing with the trusted domain cache */
 349
 350 struct winbindd_tdc_domain {
 351         const char *domain_name;
 352         const char *dns_name;
 353         struct dom_sid sid;
 354         uint32 trust_flags;
 355         uint32 trust_attribs;
 356         uint32 trust_type;
 357 };
 358
 359 /* Switch for listing users or groups */
 360 enum ent_type {
 361         LIST_USERS = 0,
 362         LIST_GROUPS,
 363 };
 364
 365 struct WINBINDD_MEMORY_CREDS {
 366         struct WINBINDD_MEMORY_CREDS *next, *prev;
 367         const char *username; /* lookup key. */
 368         uid_t uid;
 369         int ref_count;
 370         size_t len;
 371         uint8_t *nt_hash; /* Base pointer for the following 2 */
 372         uint8_t *lm_hash;
 373         char *pass;
 374 };
 375
 376 struct WINBINDD_CCACHE_ENTRY {
 377         struct WINBINDD_CCACHE_ENTRY *next, *prev;
 378         const char *principal_name;
 379         const char *ccname;
 380         const char *service;
 381         const char *username;
 382         const char *realm;
 383         struct WINBINDD_MEMORY_CREDS *cred_ptr;
 384         int ref_count;
 385         uid_t uid;
 386         time_t create_time;
 387         time_t renew_until;
 388         time_t refresh_time;
 389         struct timed_event *event;
 390 };
 391
 392 #include "winbindd/winbindd_proto.h"
 393
 394 #define WINBINDD_ESTABLISH_LOOP 30
 395 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
 396 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
 397 #define DOM_SEQUENCE_NONE ((uint32)-1)
 398
 399 #define winbind_event_context server_event_context
 400
 401 #endif /* _WINBINDD_H */