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