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/winbind.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         struct tevent_req *io_req; /* wb_req_read_* or wb_resp_write_* */
  71
  72         struct getpwent_state *pwent_state; /* State for getpwent() */
  73         struct getgrent_state *grent_state; /* State for getgrent() */
  74 };
  75
  76 struct getpwent_state {
  77         struct winbindd_domain *domain;
  78         int next_user;
  79         int num_users;
  80         struct wbint_userinfo *users;
  81 };
  82
  83 struct getgrent_state {
  84         struct winbindd_domain *domain;
  85         int next_group;
  86         int num_groups;
  87         struct wbint_Principal *groups;
  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         struct dom_sid user_sid;                    /* NT user and primary group SIDs */
  98         struct 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         enum dcerpc_AuthLevel auth_level;
 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         struct netlogon_creds_cli_context *netlogon_creds;
 117         uint32_t netlogon_flags;
 118         bool netlogon_force_reauth;
 119 };
 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 dcerpc_binding_handle *binding_handle;
 142
 143         struct tevent_timer *lockout_policy_event;
 144         struct tevent_timer *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         char *name;                            /* Domain name (NetBIOS) */
 153         char *alt_name;                        /* alt Domain name, if any (FQDN for ADS) */
 154         char *forest_name;                     /* Name of the AD forest we're in */
 155         struct dom_sid sid;                           /* SID for this domain */
 156         uint32_t domain_flags;                   /* Domain flags from netlogon.h */
 157         uint32_t domain_type;                    /* Domain type from netlogon.h */
 158         uint32_t 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 rodc;                             /* Are we an RODC for this AD domain? (do some operations locally) */
 165         bool online;                           /* is this domain available ? */
 166         time_t startup_time;                   /* When we set "startup" true. monotonic clock */
 167         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
 168
 169         bool can_do_ncacn_ip_tcp;
 170
 171         /* Lookup methods for this domain (LDAP or RPC) */
 172         struct winbindd_methods *methods;
 173
 174         /* the backend methods are used by the cache layer to find the right
 175            backend */
 176         struct winbindd_methods *backend;
 177
 178         /* Private data for the backends (used for connection cache) */
 179
 180         void *private_data;
 181
 182         /* A working DC */
 183         pid_t dc_probe_pid; /* Child we're using to detect the DC. */
 184         char *dcname;
 185         struct sockaddr_storage dcaddr;
 186
 187         /* Sequence number stuff */
 188
 189         time_t last_seq_check;
 190         uint32_t sequence_number;
 191         NTSTATUS last_status;
 192
 193         /* The smb connection */
 194
 195         struct winbindd_cm_conn conn;
 196
 197         /* The child pid we're talking to */
 198
 199         struct winbindd_child *children;
 200
 201         /* Callback we use to try put us back online. */
 202
 203         uint32_t check_online_timeout;
 204         struct tevent_timer *check_online_event;
 205
 206         /* Linked list info */
 207
 208         struct winbindd_domain *prev, *next;
 209 };
 210
 211 struct wb_acct_info {
 212         fstring acct_name; /* account name */
 213         fstring acct_desc; /* account name */
 214         uint32_t rid; /* domain-relative RID */
 215 };
 216
 217 /* per-domain methods. This is how LDAP vs RPC is selected
 218  */
 219 struct winbindd_methods {
 220         /* does this backend provide a consistent view of the data? (ie. is the primary group
 221            always correct) */
 222         bool consistent;
 223
 224         /* get a list of users, returning a wbint_userinfo for each one */
 225         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 226                                    TALLOC_CTX *mem_ctx,
 227                                    uint32_t *num_entries,
 228                                    struct wbint_userinfo **info);
 229
 230         /* get a list of domain groups */
 231         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 232                                     TALLOC_CTX *mem_ctx,
 233                                     uint32_t *num_entries,
 234                                     struct wb_acct_info **info);
 235
 236         /* get a list of domain local groups */
 237         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 238                                     TALLOC_CTX *mem_ctx,
 239                                     uint32_t *num_entries,
 240                                     struct wb_acct_info **info);
 241
 242         /* convert one user or group name to a sid */
 243         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 244                                 TALLOC_CTX *mem_ctx,
 245                                 const char *domain_name,
 246                                 const char *name,
 247                                 uint32_t flags,
 248                                 struct dom_sid *sid,
 249                                 enum lsa_SidType *type);
 250
 251         /* convert a sid to a user or group name */
 252         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 253                                 TALLOC_CTX *mem_ctx,
 254                                 const struct dom_sid *sid,
 255                                 char **domain_name,
 256                                 char **name,
 257                                 enum lsa_SidType *type);
 258
 259         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
 260                                   TALLOC_CTX *mem_ctx,
 261                                   const struct dom_sid *domain_sid,
 262                                   uint32_t *rids,
 263                                   size_t num_rids,
 264                                   char **domain_name,
 265                                   char ***names,
 266                                   enum lsa_SidType **types);
 267
 268         /* lookup user info for a given SID */
 269         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 270                                TALLOC_CTX *mem_ctx,
 271                                const struct dom_sid *user_sid,
 272                                struct wbint_userinfo *user_info);
 273
 274         /* lookup all groups that a user is a member of. The backend
 275            can also choose to lookup by username or rid for this
 276            function */
 277         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 278                                       TALLOC_CTX *mem_ctx,
 279                                       const struct dom_sid *user_sid,
 280                                       uint32_t *num_groups, struct dom_sid **user_gids);
 281
 282         /* Lookup all aliases that the sids delivered are member of. This is
 283          * to implement 'domain local groups' correctly */
 284         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
 285                                        TALLOC_CTX *mem_ctx,
 286                                        uint32_t num_sids,
 287                                        const struct dom_sid *sids,
 288                                        uint32_t *num_aliases,
 289                                        uint32_t **alias_rids);
 290
 291         /* find all members of the group with the specified group_rid */
 292         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 293                                     TALLOC_CTX *mem_ctx,
 294                                     const struct dom_sid *group_sid,
 295                                     enum lsa_SidType type,
 296                                     uint32_t *num_names,
 297                                     struct dom_sid **sid_mem, char ***names,
 298                                     uint32_t **name_types);
 299
 300         /* return the current global sequence number */
 301         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32_t *seq);
 302
 303         /* return the lockout policy */
 304         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
 305                                    TALLOC_CTX *mem_ctx,
 306                                    struct samr_DomInfo12 *lockout_policy);
 307
 308         /* return the lockout policy */
 309         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
 310                                     TALLOC_CTX *mem_ctx,
 311                                     struct samr_DomInfo1 *password_policy);
 312
 313         /* enumerate trusted domains */
 314         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
 315                                     TALLOC_CTX *mem_ctx,
 316                                     struct netr_DomainTrustList *trusts);
 317 };
 318
 319 /* Filled out by IDMAP backends */
 320 struct winbindd_idmap_methods {
 321   /* Called when backend is first loaded */
 322   bool (*init)(void);
 323
 324   bool (*get_sid_from_uid)(uid_t uid, struct dom_sid *sid);
 325   bool (*get_sid_from_gid)(gid_t gid, struct dom_sid *sid);
 326
 327   bool (*get_uid_from_sid)(struct dom_sid *sid, uid_t *uid);
 328   bool (*get_gid_from_sid)(struct dom_sid *sid, gid_t *gid);
 329
 330   /* Called when backend is unloaded */
 331   bool (*close)(void);
 332   /* Called to dump backend status */
 333   void (*status)(void);
 334 };
 335
 336 /* Data structures for dealing with the trusted domain cache */
 337
 338 struct winbindd_tdc_domain {
 339         const char *domain_name;
 340         const char *dns_name;
 341         struct dom_sid sid;
 342         uint32_t trust_flags;
 343         uint32_t trust_attribs;
 344         uint32_t trust_type;
 345 };
 346
 347 /* Switch for listing users or groups */
 348 enum ent_type {
 349         LIST_USERS = 0,
 350         LIST_GROUPS,
 351 };
 352
 353 struct WINBINDD_MEMORY_CREDS {
 354         struct WINBINDD_MEMORY_CREDS *next, *prev;
 355         const char *username; /* lookup key. */
 356         uid_t uid;
 357         int ref_count;
 358         size_t len;
 359         uint8_t *nt_hash; /* Base pointer for the following 2 */
 360         uint8_t *lm_hash;
 361         char *pass;
 362 };
 363
 364 struct WINBINDD_CCACHE_ENTRY {
 365         struct WINBINDD_CCACHE_ENTRY *next, *prev;
 366         const char *principal_name;
 367         const char *ccname;
 368         const char *service;
 369         const char *username;
 370         const char *realm;
 371         struct WINBINDD_MEMORY_CREDS *cred_ptr;
 372         int ref_count;
 373         uid_t uid;
 374         time_t create_time;
 375         time_t renew_until;
 376         time_t refresh_time;
 377         struct tevent_timer *event;
 378 };
 379
 380 #include "winbindd/winbindd_proto.h"
 381
 382 #define WINBINDD_ESTABLISH_LOOP 30
 383 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
 384 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
 385 #define DOM_SEQUENCE_NONE ((uint32_t)-1)
 386
 387 #endif /* _WINBINDD_H */