s3-auth use gensec directly rather than via auth_generic_state
[kai/samba.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5    Copyright (C) Jeremy Allison 2010
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "system/select.h"
22
23 #if defined(WITH_AIO)
24 struct aio_extra;
25 extern struct aio_extra *aio_list_head;
26 extern struct tevent_signal *aio_signal_event;
27 extern int aio_pending_size;
28 extern int outstanding_aio_calls;
29 #endif
30
31 #ifdef USE_DMAPI
32 struct smbd_dmapi_context;
33 extern struct smbd_dmapi_context *dmapi_ctx;
34 #endif
35
36 extern bool dfree_broken;
37
38 /* how many write cache buffers have been allocated */
39 extern unsigned int allocated_write_caches;
40
41 /* A singleton cache to speed up searching by dev/inode. */
42 struct fsp_singleton_cache {
43         files_struct *fsp;
44         struct file_id id;
45 };
46
47 extern const struct mangle_fns *mangle_fns;
48
49 extern unsigned char *chartest;
50 struct tdb_context;
51 extern struct tdb_context *tdb_mangled_cache;
52
53 /*
54   this determines how many characters are used from the original filename
55   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
56   The largest possible value is 6.
57 */
58 extern unsigned mangle_prefix;
59
60 struct msg_state;
61 extern struct msg_state *smbd_msg_state;
62
63 extern bool logged_ioctl_message;
64
65 extern int trans_num;
66
67 extern time_t last_smb_conf_reload_time;
68 extern time_t last_printer_reload_time;
69 extern pid_t background_lpq_updater_pid;
70
71 /****************************************************************************
72  structure to hold a linked list of queued messages.
73  for processing.
74 ****************************************************************************/
75 extern uint32_t common_flags2;
76
77 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
78 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
79
80 struct sec_ctx {
81         struct security_unix_token ut;
82         struct security_token *token;
83 };
84 /* A stack of security contexts.  We include the current context as being
85    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
86 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
87 extern int sec_ctx_stack_ndx;
88 extern bool become_uid_done;
89 extern bool become_gid_done;
90
91 extern connection_struct *last_conn;
92 extern uint16_t last_flags;
93
94 extern uint32_t global_client_caps;
95
96 extern uint16_t fnf_handle;
97
98 struct conn_ctx {
99         connection_struct *conn;
100         uint16 vuid;
101 };
102 /* A stack of current_user connection contexts. */
103 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
104 extern int conn_ctx_stack_ndx;
105
106 struct vfs_init_function_entry;
107 extern struct vfs_init_function_entry *backends;
108 extern char *sparse_buf;
109 extern char *LastDir;
110
111 /* Current number of oplocks we have outstanding. */
112 extern int32_t exclusive_oplocks_open;
113 extern int32_t level_II_oplocks_open;
114 extern struct kernel_oplocks *koplocks;
115
116 struct smbd_parent_context;
117 extern struct smbd_parent_context *am_parent;
118 extern struct memcache *smbd_memcache_ctx;
119 extern bool exit_firsttime;
120
121 struct tstream_context;
122 struct smbd_smb2_request;
123 struct smbd_smb2_session;
124 struct smbd_smb2_tcon;
125
126 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
127
128 void smbd_lock_socket(struct smbd_server_connection *sconn);
129 void smbd_unlock_socket(struct smbd_server_connection *sconn);
130
131 NTSTATUS smbd_do_locking(struct smb_request *req,
132                          files_struct *fsp,
133                          uint8_t type,
134                          int32_t timeout,
135                          uint16_t num_ulocks,
136                          struct smbd_lock_element *ulocks,
137                          uint16_t num_locks,
138                          struct smbd_lock_element *locks,
139                          bool *async);
140
141 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
142                                TALLOC_CTX *mem_ctx,
143                                uint16_t info_level,
144                                files_struct *fsp,
145                                struct smb_filename *smb_fname,
146                                bool delete_pending,
147                                struct timespec write_time_ts,
148                                struct ea_list *ea_list,
149                                int lock_data_count,
150                                char *lock_data,
151                                uint16_t flags2,
152                                unsigned int max_data_bytes,
153                                char **ppdata,
154                                unsigned int *pdata_size);
155
156 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
157                                 struct smb_request *req,
158                                 TALLOC_CTX *mem_ctx,
159                                 uint16_t info_level,
160                                 files_struct *fsp,
161                                 struct smb_filename *smb_fname,
162                                 char **ppdata, int total_data,
163                                 int *ret_data_size);
164
165 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
166                          TALLOC_CTX *mem_ctx,
167                          uint16_t info_level,
168                          uint16_t flags2,
169                          unsigned int max_data_bytes,
170                          char **ppdata,
171                          int *ret_data_len);
172
173 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
174                            struct dptr_struct *dirptr,
175                            const char *mask,
176                            uint32_t dirtype,
177                            bool dont_descend,
178                            bool ask_sharemode,
179                            bool (*match_fn)(TALLOC_CTX *ctx,
180                                             void *private_data,
181                                             const char *dname,
182                                             const char *mask,
183                                             char **_fname),
184                            bool (*mode_fn)(TALLOC_CTX *ctx,
185                                            void *private_data,
186                                            struct smb_filename *smb_fname,
187                                            uint32_t *_mode),
188                            void *private_data,
189                            char **_fname,
190                            struct smb_filename **_smb_fname,
191                            uint32_t *_mode,
192                            long *_prev_offset);
193
194 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
195                                connection_struct *conn,
196                                struct dptr_struct *dirptr,
197                                uint16 flags2,
198                                const char *path_mask,
199                                uint32 dirtype,
200                                int info_level,
201                                int requires_resume_key,
202                                bool dont_descend,
203                                bool ask_sharemode,
204                                uint8_t align,
205                                bool do_pad,
206                                char **ppdata,
207                                char *base_data,
208                                char *end_data,
209                                int space_remaining,
210                                bool *out_of_space,
211                                bool *got_exact_match,
212                                int *_last_entry_off,
213                                struct ea_list *name_list);
214
215 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
216                                     const struct smb_filename *smb_fname,
217                                     uint32_t access_mask,
218                                     uint32_t *access_mask_out);
219
220 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
221
222 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
223                                          const char *reason,
224                                          const char *location);
225 #define smbd_server_connection_terminate(sconn, reason) \
226         smbd_server_connection_terminate_ex(sconn, reason, __location__)
227
228 const char *smb2_opcode_name(uint16_t opcode);
229 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
230
231 void reply_smb2002(struct smb_request *req, uint16_t choice);
232 void reply_smb20ff(struct smb_request *req, uint16_t choice);
233 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
234                              const uint8_t *inbuf, size_t size);
235
236 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
237                                     NTSTATUS status,
238                                     DATA_BLOB *info,
239                                     const char *location);
240 #define smbd_smb2_request_error(req, status) \
241         smbd_smb2_request_error_ex(req, status, NULL, __location__)
242 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
243                                    NTSTATUS status,
244                                    DATA_BLOB body, DATA_BLOB *dyn,
245                                    const char *location);
246 #define smbd_smb2_request_done(req, body, dyn) \
247         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
248
249 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
250                                      uint64_t file_id_persistent,
251                                      uint64_t file_id_volatile,
252                                      uint8_t oplock_level);
253
254 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
255                                          struct tevent_req *subreq,
256                                          uint32_t defer_time);
257
258 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
259 void remove_smb2_chained_fsp(files_struct *fsp);
260
261 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
262                                         size_t expected_body_size);
263
264 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
271 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
273 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
274 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
275 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
276 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
285 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
286                                 struct tevent_immediate *im,
287                                 void *private_data);
288
289 /* SMB1 -> SMB2 glue. */
290 void send_break_message_smb2(files_struct *fsp, int level);
291 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
292 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
293                                 struct smb_request *req,
294                                 files_struct *fsp,
295                                 int lock_timeout,
296                                 int lock_num,
297                                 uint64_t smblctx,
298                                 enum brl_type lock_type,
299                                 enum brl_flavour lock_flav,
300                                 uint64_t offset,
301                                 uint64_t count,
302                                 uint64_t blocking_smblctx);
303 void process_blocking_lock_queue_smb2(
304         struct smbd_server_connection *sconn, struct timeval tv_curr);
305 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
306                         struct byte_range_lock *br_lck,
307                         enum file_close_type close_type);
308 /* From smbd/smb2_create.c */
309 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
310 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
311                         struct timeval *p_request_time,
312                         void **pp_state);
313 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
314                             uint64_t mid);
315 void remove_deferred_open_message_smb2(
316         struct smbd_server_connection *sconn, uint64_t mid);
317 void schedule_deferred_open_message_smb2(
318         struct smbd_server_connection *sconn, uint64_t mid);
319 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
320                         struct timeval request_time,
321                         struct timeval timeout,
322                         struct file_id id,
323                         char *private_data,
324                         size_t priv_len);
325
326 struct smbd_smb2_request {
327         struct smbd_smb2_request *prev, *next;
328
329         TALLOC_CTX *mem_pool;
330         struct smbd_smb2_request **parent;
331
332         struct smbd_server_connection *sconn;
333
334         /* the session the request operates on, maybe NULL */
335         struct smbd_smb2_session *session;
336         uint64_t last_session_id;
337
338         /* the tcon the request operates on, maybe NULL */
339         struct smbd_smb2_tcon *tcon;
340         uint32_t last_tid;
341
342         int current_idx;
343         bool do_signing;
344         struct tevent_timer *async_te;
345         bool cancelled;
346         bool compound_related;
347
348         /* fake smb1 request. */
349         struct smb_request *smb1req;
350         struct files_struct *compat_chain_fsp;
351
352         NTSTATUS next_status;
353
354         /*
355          * The sub request for async backend calls.
356          * This is used for SMB2 Cancel.
357          */
358         struct tevent_req *subreq;
359
360         struct {
361                 /* the NBT header is not allocated */
362                 uint8_t nbt_hdr[4];
363                 /*
364                  * vector[0] NBT
365                  * .
366                  * vector[1] SMB2
367                  * vector[2] fixed body
368                  * vector[3] dynamic body
369                  * .
370                  * .
371                  * .
372                  * vector[4] SMB2
373                  * vector[5] fixed body
374                  * vector[6] dynamic body
375                  * .
376                  * .
377                  * .
378                  */
379                 struct iovec *vector;
380                 int vector_count;
381         } in;
382         struct {
383                 /* the NBT header is not allocated */
384                 uint8_t nbt_hdr[4];
385                 /*
386                  * vector[0] NBT
387                  * .
388                  * vector[1] SMB2
389                  * vector[2] fixed body
390                  * vector[3] dynamic body
391                  * .
392                  * .
393                  * .
394                  * vector[4] SMB2
395                  * vector[5] fixed body
396                  * vector[6] dynamic body
397                  * .
398                  * .
399                  * .
400                  */
401                 struct iovec *vector;
402                 int vector_count;
403         } out;
404 };
405
406 struct smbd_server_connection;
407
408 struct smbd_smb2_session {
409         struct smbd_smb2_session *prev, *next;
410         struct smbd_server_connection *sconn;
411         NTSTATUS status;
412         uint64_t vuid;
413         struct gensec_security *gensec_security;
414         struct auth_session_info *session_info;
415         DATA_BLOB session_key;
416         bool do_signing;
417
418         user_struct *compat_vuser;
419
420         struct {
421                 /* an id tree used to allocate tids */
422                 struct idr_context *idtree;
423
424                 /* this is the limit of tid values for this connection */
425                 uint32_t limit;
426
427                 struct smbd_smb2_tcon *list;
428         } tcons;
429 };
430
431 struct smbd_smb2_tcon {
432         struct smbd_smb2_tcon *prev, *next;
433         struct smbd_smb2_session *session;
434         uint32_t tid;
435         int snum;
436         connection_struct *compat_conn;
437 };
438
439 struct pending_message_list;
440 struct pending_auth_data;
441
442 struct smbd_server_connection {
443         int sock;
444         const struct tsocket_address *local_address;
445         const struct tsocket_address *remote_address;
446         const char *remote_hostname;
447         struct tevent_context *ev_ctx;
448         struct messaging_context *msg_ctx;
449         struct {
450                 bool got_session;
451         } nbt;
452         bool using_smb2;
453         int trans_num;
454
455         /*
456          * Cache for calling poll(2) to avoid allocations in our
457          * central event loop
458          */
459         struct pollfd *pfds;
460
461         struct files_struct *files;
462         struct bitmap *file_bmap;
463         int real_max_open_files;
464         int files_used;
465         struct fsp_singleton_cache fsp_fi_cache;
466         unsigned long file_gen_counter;
467         int first_file;
468
469         /* Try GENSEC hook */
470         bool use_gensec_hook;
471
472         /* number of open connections (tcons) */
473         int num_tcons_open;
474
475         struct pending_message_list *deferred_open_queue;
476
477
478         /* open directory handles. */
479         struct {
480                 struct bitmap *dptr_bmap;
481                 struct dptr_struct *dirptrs;
482                 int dirhandles_open;
483         } searches;
484
485         uint64_t num_requests;
486
487         struct {
488                 struct fd_event *fde;
489
490                 struct {
491                         /*
492                          * fd for the fcntl lock mutexing access to our sock
493                          */
494                         int socket_lock_fd;
495
496                         /*
497                          * fd for the trusted pipe from
498                          * echo handler child
499                          */
500                         int trusted_fd;
501
502                         /*
503                          * fde for the trusted_fd
504                          */
505                         struct fd_event *trusted_fde;
506
507                         /*
508                          * Reference count for the fcntl lock to
509                          * allow recursive locks.
510                          */
511                         int ref_count;
512                 } echo_handler;
513
514                 struct {
515                         bool encrypted_passwords;
516                         bool spnego;
517                         struct auth_context *auth_context;
518                         bool done;
519                         /*
520                          * Size of the data we can receive. Set by us.
521                          * Can be modified by the max xmit parameter.
522                          */
523                         int max_recv;
524                 } negprot;
525
526                 struct {
527                         uint16_t client_major;
528                         uint16_t client_minor;
529                         uint32_t client_cap_low;
530                         uint32_t client_cap_high;
531                 } unix_info;
532
533                 struct {
534                         bool done_sesssetup;
535                         /*
536                          * Size of data we can send to client. Set
537                          *  by the client for all protocols above CORE.
538                          *  Set by us for CORE protocol.
539                          */
540                         int max_send;
541                         uint16_t last_session_tag;
542
543                         /* users from session setup */
544                         char *session_userlist;
545                         /* workgroup from session setup. */
546                         char *session_workgroup;
547                         /*
548                          * this holds info on user ids that are already
549                          * validated for this VC
550                          */
551                         user_struct *validated_users;
552                         uint16_t next_vuid;
553                         int num_validated_vuids;
554                 } sessions;
555                 struct {
556                         connection_struct *Connections;
557                         /* number of open connections */
558                         struct bitmap *bmap;
559                 } tcons;
560                 struct smb_signing_state *signing_state;
561                 /* List to store partial SPNEGO auth fragments. */
562                 struct pending_auth_data *pd_list;
563
564                 struct notify_mid_map *notify_mid_maps;
565
566                 struct {
567                         /* dlink list we store pending lock records on. */
568                         struct blocking_lock_record *blocking_lock_queue;
569                         /* dlink list we move cancelled lock records onto. */
570                         struct blocking_lock_record *blocking_lock_cancelled_queue;
571
572                         /* The event that makes us process our blocking lock queue */
573                         struct timed_event *brl_timeout;
574
575                         bool blocking_lock_unlock_state;
576                         bool blocking_lock_cancel_state;
577                 } locks;
578         } smb1;
579         struct {
580                 struct tevent_queue *recv_queue;
581                 struct tevent_queue *send_queue;
582                 struct tstream_context *stream;
583                 bool negprot_2ff;
584                 struct {
585                         /* an id tree used to allocate vuids */
586                         /* this holds info on session vuids that are already
587                          * validated for this VC */
588                         struct idr_context *idtree;
589
590                         /* this is the limit of vuid values for this connection */
591                         uint64_t limit;
592
593                         struct smbd_smb2_session *list;
594                 } sessions;
595                 struct {
596                         /* The event that makes us process our blocking lock queue */
597                         struct timed_event *brl_timeout;
598                         bool blocking_lock_unlock_state;
599                 } locks;
600                 struct smbd_smb2_request *requests;
601                 uint64_t seqnum_low;
602                 uint32_t credits_granted;
603                 uint32_t max_credits;
604                 uint32_t max_trans;
605                 uint32_t max_read;
606                 uint32_t max_write;
607                 struct bitmap *credits_bitmap;
608                 bool compound_related_in_progress;
609         } smb2;
610 };
611
612 extern struct smbd_server_connection *smbd_server_conn;
613
614 void smbd_init_globals(void);