source/nsswitch/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 Library General Public
  11    License as published by the Free Software Foundation; either
  12    version 2 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 Library General Public
  20    License along with this library; if not, write to the
  21    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22    Boston, MA  02111-1307, USA.
  23 */
  24
  25 #ifndef _WINBINDD_H
  26 #define _WINBINDD_H
  27
  28 #include "nterr.h"
  29
  30 #include "winbindd_nss.h"
  31
  32 #undef DBGC_CLASS
  33 #define DBGC_CLASS DBGC_WINBIND
  34
  35 /* bits for fd_event.flags */
  36 #define EVENT_FD_READ 1
  37 #define EVENT_FD_WRITE 2
  38
  39 struct fd_event {
  40         struct fd_event *next, *prev;
  41         int fd;
  42         int flags; /* see EVENT_FD_* flags */
  43         void (*handler)(struct fd_event *fde, int flags);
  44         void *data;
  45         size_t length, done;
  46         void (*finished)(void *private, BOOL success);
  47         void *private;
  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         struct fd_event fd_event;
  54         pid_t pid;                                /* pid of client */
  55         int read_buf_len, write_buf_len;          /* Indexes in request/response */
  56         BOOL finished;                            /* Can delete from list */
  57         BOOL write_extra_data;                    /* Write extra_data field */
  58         time_t last_access;                       /* Time of last access (read or write) */
  59         BOOL privileged;                           /* Is the client 'privileged' */
  60
  61         TALLOC_CTX *mem_ctx;                      /* memory per request */
  62         struct winbindd_request request;          /* Request from client */
  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 *getpwent_state;      /* State for getpwent() */
  69         struct getent_state *getgrent_state;      /* State for getgrent() */
  70 };
  71
  72 /* State between get{pw,gr}ent() calls */
  73
  74 struct getent_state {
  75         struct getent_state *prev, *next;
  76         void *sam_entries;
  77         uint32 sam_entry_index, num_sam_entries;
  78         BOOL got_sam_entries;
  79         fstring domain_name;
  80 };
  81
  82 /* Storage for cached getpwent() user entries */
  83
  84 struct getpwent_user {
  85         fstring name;                        /* Account name */
  86         fstring gecos;                       /* User information */
  87         DOM_SID user_sid;                    /* NT user and primary group SIDs */
  88         DOM_SID group_sid;
  89 };
  90
  91 /* Server state structure */
  92
  93 struct winbindd_state {
  94
  95         /* User and group id pool */
  96
  97         uid_t uid_low, uid_high;               /* Range of uids to allocate */
  98         gid_t gid_low, gid_high;               /* Range of gids to allocate */
  99 };
 100
 101 extern struct winbindd_state server_state;  /* Server information */
 102
 103 typedef struct {
 104         char *acct_name;
 105         char *full_name;
 106         DOM_SID user_sid;                    /* NT user and primary group SIDs */
 107         DOM_SID group_sid;
 108 } WINBIND_USERINFO;
 109
 110 /* Our connection to the DC */
 111
 112 struct winbindd_cm_conn {
 113         struct cli_state *cli;
 114
 115         struct rpc_pipe_client *samr_pipe;
 116         POLICY_HND sam_connect_handle, sam_domain_handle;
 117
 118         struct rpc_pipe_client *lsa_pipe;
 119         POLICY_HND lsa_policy;
 120
 121         /* Auth2 pipe is the pipe used to setup the netlogon schannel key
 122          * using rpccli_net_auth2. It needs to be kept open. */
 123
 124         struct rpc_pipe_client *netlogon_auth2_pipe;
 125         unsigned char sess_key[16];        /* Current session key. */
 126         DOM_CRED clnt_cred;                /* Client NETLOGON credential. */
 127         struct rpc_pipe_client *netlogon_pipe;
 128 };
 129
 130 struct winbindd_async_request;
 131
 132 /* Async child */
 133
 134 struct winbindd_child {
 135         struct winbindd_child *next, *prev;
 136
 137         pid_t pid;
 138         struct winbindd_domain *domain;
 139         pstring logfilename;
 140
 141         struct fd_event event;
 142         struct winbindd_async_request *requests;
 143 };
 144
 145 /* Structures to hold per domain information */
 146
 147 struct winbindd_domain {
 148         fstring name;                          /* Domain name */
 149         fstring alt_name;                      /* alt Domain name (if any) */
 150         DOM_SID sid;                           /* SID for this domain */
 151         BOOL initialized;                      /* Did we already ask for the domain mode? */
 152         BOOL native_mode;                      /* is this a win2k domain in native mode ? */
 153         BOOL active_directory;                 /* is this a win2k active directory ? */
 154         BOOL primary;                          /* is this our primary domain ? */
 155         BOOL internal;          /* BUILTIN and member SAM */
 156
 157         /* Lookup methods for this domain (LDAP or RPC) */
 158         struct winbindd_methods *methods;
 159
 160         /* the backend methods are used by the cache layer to find the right
 161            backend */
 162         struct winbindd_methods *backend;
 163
 164         /* Private data for the backends (used for connection cache) */
 165
 166         void *private;
 167
 168         /* A working DC */
 169         fstring dcname;
 170         struct sockaddr_in dcaddr;
 171
 172         /* Sequence number stuff */
 173
 174         time_t last_seq_check;
 175         uint32 sequence_number;
 176         NTSTATUS last_status;
 177
 178         /* The smb connection */
 179
 180         struct winbindd_cm_conn conn;
 181
 182         /* The child pid we're talking to */
 183
 184         struct winbindd_child child;
 185
 186         /* Linked list info */
 187
 188         struct winbindd_domain *prev, *next;
 189 };
 190
 191 /* per-domain methods. This is how LDAP vs RPC is selected
 192  */
 193 struct winbindd_methods {
 194         /* does this backend provide a consistent view of the data? (ie. is the primary group
 195            always correct) */
 196         BOOL consistent;
 197
 198         /* get a list of users, returning a WINBIND_USERINFO for each one */
 199         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 200                                    TALLOC_CTX *mem_ctx,
 201                                    uint32 *num_entries,
 202                                    WINBIND_USERINFO **info);
 203
 204         /* get a list of domain groups */
 205         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 206                                     TALLOC_CTX *mem_ctx,
 207                                     uint32 *num_entries,
 208                                     struct acct_info **info);
 209
 210         /* get a list of domain local groups */
 211         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 212                                     TALLOC_CTX *mem_ctx,
 213                                     uint32 *num_entries,
 214                                     struct acct_info **info);
 215
 216         /* convert one user or group name to a sid */
 217         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 218                                 TALLOC_CTX *mem_ctx,
 219                                 const char *domain_name,
 220                                 const char *name,
 221                                 DOM_SID *sid,
 222                                 enum SID_NAME_USE *type);
 223
 224         /* convert a sid to a user or group name */
 225         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 226                                 TALLOC_CTX *mem_ctx,
 227                                 const DOM_SID *sid,
 228                                 char **domain_name,
 229                                 char **name,
 230                                 enum SID_NAME_USE *type);
 231
 232         /* lookup user info for a given SID */
 233         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 234                                TALLOC_CTX *mem_ctx,
 235                                const DOM_SID *user_sid,
 236                                WINBIND_USERINFO *user_info);
 237
 238         /* lookup all groups that a user is a member of. The backend
 239            can also choose to lookup by username or rid for this
 240            function */
 241         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 242                                       TALLOC_CTX *mem_ctx,
 243                                       const DOM_SID *user_sid,
 244                                       uint32 *num_groups, DOM_SID **user_gids);
 245
 246         /* Lookup all aliases that the sids delivered are member of. This is
 247          * to implement 'domain local groups' correctly */
 248         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
 249                                        TALLOC_CTX *mem_ctx,
 250                                        uint32 num_sids,
 251                                        const DOM_SID *sids,
 252                                        uint32 *num_aliases,
 253                                        uint32 **alias_rids);
 254
 255         /* find all members of the group with the specified group_rid */
 256         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 257                                     TALLOC_CTX *mem_ctx,
 258                                     const DOM_SID *group_sid,
 259                                     uint32 *num_names,
 260                                     DOM_SID **sid_mem, char ***names,
 261                                     uint32 **name_types);
 262
 263         /* return the current global sequence number */
 264         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
 265
 266         /* enumerate trusted domains */
 267         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
 268                                     TALLOC_CTX *mem_ctx,
 269                                     uint32 *num_domains,
 270                                     char ***names,
 271                                     char ***alt_names,
 272                                     DOM_SID **dom_sids);
 273
 274         /* setup the list of alternate names for the domain, if any */
 275         NTSTATUS (*alternate_name)(struct winbindd_domain *domain);
 276 };
 277
 278 /* Used to glue a policy handle and cli_state together */
 279
 280 typedef struct {
 281         struct cli_state *cli;
 282         POLICY_HND pol;
 283 } CLI_POLICY_HND;
 284
 285 /* Filled out by IDMAP backends */
 286 struct winbindd_idmap_methods {
 287   /* Called when backend is first loaded */
 288   BOOL (*init)(void);
 289
 290   BOOL (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
 291   BOOL (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
 292
 293   BOOL (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
 294   BOOL (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
 295
 296   /* Called when backend is unloaded */
 297   BOOL (*close)(void);
 298   /* Called to dump backend status */
 299   void (*status)(void);
 300 };
 301
 302 #include "nsswitch/winbindd_proto.h"
 303
 304 #include "rpc_parse.h"
 305
 306 #define WINBINDD_ESTABLISH_LOOP 30
 307 #define WINBINDD_RESCAN_FREQ 300
 308
 309 #define DOM_SEQUENCE_NONE ((uint32)-1)
 310
 311 #endif /* _WINBINDD_H */