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