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