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
  28 #ifdef HAVE_LIBNSCD
  29 #include <libnscd.h>
  30 #endif
  31
  32 #ifdef HAVE_SYS_MMAN_H
  33 #include <sys/mman.h>
  34 #endif
  35
  36 #undef DBGC_CLASS
  37 #define DBGC_CLASS DBGC_WINBIND
  38
  39 #define WB_REPLACE_CHAR         '_'
  40
  41 /* bits for fd_event.flags */
  42 #define EVENT_FD_READ 1
  43 #define EVENT_FD_WRITE 2
  44
  45 struct fd_event {
  46         struct fd_event *next, *prev;
  47         int fd;
  48         int flags; /* see EVENT_FD_* flags */
  49         void (*handler)(struct fd_event *fde, int flags);
  50         void *data;
  51         size_t length, done;
  52         void (*finished)(void *private_data, bool success);
  53         void *private_data;
  54 };
  55
  56 struct sid_ctr {
  57         DOM_SID *sid;
  58         bool finished;
  59         const char *domain;
  60         const char *name;
  61         enum lsa_SidType type;
  62 };
  63
  64 struct winbindd_cli_state {
  65         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
  66         int sock;                                 /* Open socket from client */
  67         struct fd_event fd_event;
  68         pid_t pid;                                /* pid of client */
  69         bool finished;                            /* Can delete from list */
  70         bool write_extra_data;                    /* Write extra_data field */
  71         time_t last_access;                       /* Time of last access (read or write) */
  72         bool privileged;                           /* Is the client 'privileged' */
  73
  74         TALLOC_CTX *mem_ctx;                      /* memory per request */
  75         struct winbindd_request request;          /* Request from client */
  76         struct winbindd_response response;        /* Respose to client */
  77         bool getpwent_initialized;                /* Has getpwent_state been
  78                                                    * initialized? */
  79         bool getgrent_initialized;                /* Has getgrent_state been
  80                                                    * initialized? */
  81         struct getent_state *getpwent_state;      /* State for getpwent() */
  82         struct getent_state *getgrent_state;      /* State for getgrent() */
  83 };
  84
  85 /* State between get{pw,gr}ent() calls */
  86
  87 struct getent_state {
  88         struct getent_state *prev, *next;
  89         void *sam_entries;
  90         uint32 sam_entry_index, num_sam_entries;
  91         bool got_sam_entries;
  92         fstring domain_name;
  93 };
  94
  95 /* Storage for cached getpwent() user entries */
  96
  97 struct getpwent_user {
  98         fstring name;                        /* Account name */
  99         fstring gecos;                       /* User information */
 100         fstring homedir;                     /* User Home Directory */
 101         fstring shell;                       /* User Login Shell */
 102         DOM_SID user_sid;                    /* NT user and primary group SIDs */
 103         DOM_SID group_sid;
 104 };
 105
 106 /* Server state structure */
 107
 108 typedef struct {
 109         char *acct_name;
 110         char *full_name;
 111         char *homedir;
 112         char *shell;
 113         gid_t primary_gid;                   /* allow the nss_info
 114                                                 backend to set the primary group */
 115         DOM_SID user_sid;                    /* NT user and primary group SIDs */
 116         DOM_SID group_sid;
 117 } WINBIND_USERINFO;
 118
 119 /* Our connection to the DC */
 120
 121 struct winbindd_cm_conn {
 122         struct cli_state *cli;
 123
 124         struct rpc_pipe_client *samr_pipe;
 125         POLICY_HND sam_connect_handle, sam_domain_handle;
 126
 127         struct rpc_pipe_client *lsa_pipe;
 128         POLICY_HND lsa_policy;
 129
 130         struct rpc_pipe_client *netlogon_pipe;
 131 };
 132
 133 struct winbindd_async_request;
 134
 135 /* Async child */
 136
 137 struct winbindd_domain;
 138
 139 struct winbindd_child_dispatch_table {
 140         enum winbindd_cmd cmd;
 141         enum winbindd_result (*fn)(struct winbindd_domain *domain,
 142                                    struct winbindd_cli_state *state);
 143         const char *winbindd_cmd_name;
 144 };
 145
 146 extern const struct winbindd_child_dispatch_table domain_dispatch_table[];
 147
 148 struct winbindd_child {
 149         struct winbindd_child *next, *prev;
 150
 151         pid_t pid;
 152         struct winbindd_domain *domain;
 153         char *logfilename;
 154
 155         struct fd_event event;
 156         struct timed_event *lockout_policy_event;
 157         struct winbindd_async_request *requests;
 158
 159         const struct winbindd_child_dispatch_table *table;
 160 };
 161
 162 /* Structures to hold per domain information */
 163
 164 struct winbindd_domain {
 165         fstring name;                          /* Domain name (NetBIOS) */
 166         fstring alt_name;                      /* alt Domain name, if any (FQDN for ADS) */
 167         fstring forest_name;                   /* Name of the AD forest we're in */
 168         DOM_SID sid;                           /* SID for this domain */
 169         uint32 domain_flags;                   /* Domain flags from rpc_ds.h */
 170         uint32 domain_type;                    /* Domain type from rpc_ds.h */
 171         uint32 domain_trust_attribs;           /* Trust attribs from rpc_ds.h */
 172         bool initialized;                      /* Did we already ask for the domain mode? */
 173         bool native_mode;                      /* is this a win2k domain in native mode ? */
 174         bool active_directory;                 /* is this a win2k active directory ? */
 175         bool primary;                          /* is this our primary domain ? */
 176         bool internal;                         /* BUILTIN and member SAM */
 177         bool online;                           /* is this domain available ? */
 178         time_t startup_time;                   /* When we set "startup" true. */
 179         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
 180
 181         /* Lookup methods for this domain (LDAP or RPC) */
 182         struct winbindd_methods *methods;
 183
 184         /* the backend methods are used by the cache layer to find the right
 185            backend */
 186         struct winbindd_methods *backend;
 187
 188         /* Private data for the backends (used for connection cache) */
 189
 190         void *private_data;
 191
 192         /* A working DC */
 193         fstring 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 child;
 209
 210         /* Callback we use to try put us back online. */
 211
 212         uint32 check_online_timeout;
 213         struct timed_event *check_online_event;
 214
 215         /* Linked list info */
 216
 217         struct winbindd_domain *prev, *next;
 218 };
 219
 220 /* per-domain methods. This is how LDAP vs RPC is selected
 221  */
 222 struct winbindd_methods {
 223         /* does this backend provide a consistent view of the data? (ie. is the primary group
 224            always correct) */
 225         bool consistent;
 226
 227         /* get a list of users, returning a WINBIND_USERINFO for each one */
 228         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 229                                    TALLOC_CTX *mem_ctx,
 230                                    uint32 *num_entries,
 231                                    WINBIND_USERINFO **info);
 232
 233         /* get a list of domain groups */
 234         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 235                                     TALLOC_CTX *mem_ctx,
 236                                     uint32 *num_entries,
 237                                     struct acct_info **info);
 238
 239         /* get a list of domain local groups */
 240         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 241                                     TALLOC_CTX *mem_ctx,
 242                                     uint32 *num_entries,
 243                                     struct acct_info **info);
 244
 245         /* convert one user or group name to a sid */
 246         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 247                                 TALLOC_CTX *mem_ctx,
 248                                 enum winbindd_cmd orig_cmd,
 249                                 const char *domain_name,
 250                                 const char *name,
 251                                 DOM_SID *sid,
 252                                 enum lsa_SidType *type);
 253
 254         /* convert a sid to a user or group name */
 255         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 256                                 TALLOC_CTX *mem_ctx,
 257                                 const DOM_SID *sid,
 258                                 char **domain_name,
 259                                 char **name,
 260                                 enum lsa_SidType *type);
 261
 262         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
 263                                   TALLOC_CTX *mem_ctx,
 264                                   const DOM_SID *domain_sid,
 265                                   uint32 *rids,
 266                                   size_t num_rids,
 267                                   char **domain_name,
 268                                   char ***names,
 269                                   enum lsa_SidType **types);
 270
 271         /* lookup user info for a given SID */
 272         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 273                                TALLOC_CTX *mem_ctx,
 274                                const DOM_SID *user_sid,
 275                                WINBIND_USERINFO *user_info);
 276
 277         /* lookup all groups that a user is a member of. The backend
 278            can also choose to lookup by username or rid for this
 279            function */
 280         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 281                                       TALLOC_CTX *mem_ctx,
 282                                       const DOM_SID *user_sid,
 283                                       uint32 *num_groups, DOM_SID **user_gids);
 284
 285         /* Lookup all aliases that the sids delivered are member of. This is
 286          * to implement 'domain local groups' correctly */
 287         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
 288                                        TALLOC_CTX *mem_ctx,
 289                                        uint32 num_sids,
 290                                        const DOM_SID *sids,
 291                                        uint32 *num_aliases,
 292                                        uint32 **alias_rids);
 293
 294         /* find all members of the group with the specified group_rid */
 295         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 296                                     TALLOC_CTX *mem_ctx,
 297                                     const DOM_SID *group_sid,
 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                                    SAM_UNK_INFO_12 *lockout_policy);
 309
 310         /* return the lockout policy */
 311         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
 312                                     TALLOC_CTX *mem_ctx,
 313                                     SAM_UNK_INFO_1 *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 /* Used to glue a policy handle and cli_state together */
 325
 326 typedef struct {
 327         struct cli_state *cli;
 328         POLICY_HND pol;
 329 } CLI_POLICY_HND;
 330
 331 /* Filled out by IDMAP backends */
 332 struct winbindd_idmap_methods {
 333   /* Called when backend is first loaded */
 334   bool (*init)(void);
 335
 336   bool (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
 337   bool (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
 338
 339   bool (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
 340   bool (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
 341
 342   /* Called when backend is unloaded */
 343   bool (*close)(void);
 344   /* Called to dump backend status */
 345   void (*status)(void);
 346 };
 347
 348 /* Data structures for dealing with the trusted domain cache */
 349
 350 struct winbindd_tdc_domain {
 351         const char *domain_name;
 352         const char *dns_name;
 353         DOM_SID sid;
 354         uint32 trust_flags;
 355         uint32 trust_attribs;
 356         uint32 trust_type;
 357 };
 358
 359
 360 #include "winbindd/winbindd_proto.h"
 361
 362 #define WINBINDD_ESTABLISH_LOOP 30
 363 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
 364 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
 365 #define DOM_SEQUENCE_NONE ((uint32)-1)
 366
 367 #define IS_DOMAIN_OFFLINE(x) ( lp_winbind_offline_logon() && \
 368                                ( get_global_winbindd_state_offline() \
 369                                  || !(x)->online ) )
 370 #endif /* _WINBINDD_H */