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