4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
20 #include <linux/in6.h>
21 #include "cifs_fs_sb.h"
24 * The sizes of various internal tables and strings
26 #define MAX_UID_INFO 16
27 #define MAX_SES_INFO 2
28 #define MAX_TCON_INFO 4
30 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
31 #define MAX_SERVER_SIZE 15
32 #define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
33 #define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
34 termination then *2 for unicode versions */
35 #define MAX_PASSWORD_SIZE 16
37 #define CIFS_MIN_RCV_POOL 4
40 * MAX_REQ is the maximum number of requests that WE will send
41 * on one socket concurently. It also matches the most common
42 * value of max multiplex returned by servers. We may
43 * eventually want to use the negotiated value (in case
44 * future servers can handle more) when we are more confident that
45 * we will not have problems oveloading the socket with pending
48 #define CIFS_MAX_REQ 50
50 #define RFC1001_NAME_LEN 15
51 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
53 /* currently length of NIP6_FMT */
54 #define SERVER_NAME_LENGTH 40
55 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
57 /* used to define string lengths for reversing unicode strings */
59 /* (max path length + 1 for null) * 2 for unicode */
64 #ifndef XATTR_DOS_ATTRIB
65 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
69 * CIFS vfs client Status information (based on what we know.)
72 /* associated with each tcp and smb session */
81 PLAINTXT = 0, /* Legacy with Plaintext passwords */
82 LANMAN, /* Legacy LANMAN auth */
83 NTLM, /* Legacy NTLM012 auth with NTLM hash */
84 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
85 RawNTLMSSP, /* NTLMSSP without SPNEGO */
86 NTLMSSP, /* NTLMSSP via SPNEGO */
87 Kerberos, /* Kerberos via SPNEGO */
88 MSKerberos, /* MS Kerberos via SPNEGO */
94 /* Netbios frames protocol not supported at this time */
100 char ntlm[CIFS_SESS_KEY_SIZE + 16];
101 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
104 struct ntlmv2_resp resp;
114 struct cifs_sid osid;
115 struct cifs_sid gsid;
116 struct cifs_ntace *ntaces;
117 struct cifs_ace *aces;
121 *****************************************************************
122 * Except the CIFS PDUs themselves all the
123 * globally interesting structs should go here
124 *****************************************************************
127 struct TCP_Server_Info {
128 struct list_head tcp_ses_list;
129 struct list_head smb_ses_list;
130 int srv_count; /* reference counter */
131 /* 15 character server name + 0x20 16th byte indicating type = srv */
132 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
133 char *hostname; /* hostname portion of UNC string */
134 struct socket *ssocket;
136 struct sockaddr_in sockAddr;
137 struct sockaddr_in6 sockAddr6;
139 wait_queue_head_t response_q;
140 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
141 struct list_head pending_mid_q;
142 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
143 unsigned short server_codepage; /* codepage for the server */
144 unsigned long ip_address; /* IP addr for the server if known */
145 enum protocolEnum protocolType;
148 bool svlocal:1; /* local server or remote */
149 bool noblocksnd; /* use blocking sendmsg */
150 bool noautotune; /* do not autotune send buf sizes */
151 atomic_t inFlight; /* number of requests on the wire to server */
152 #ifdef CONFIG_CIFS_STATS2
153 atomic_t inSend; /* requests trying to send */
154 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
156 enum statusEnum tcpStatus; /* what we think the status is */
157 struct mutex srv_mutex;
158 struct task_struct *tsk;
159 char server_GUID[16];
161 enum securityEnum secType;
162 unsigned int maxReq; /* Clients should submit no more */
163 /* than maxReq distinct unanswered SMBs to the server when using */
164 /* multiplexed reads or writes */
165 unsigned int maxBuf; /* maxBuf specifies the maximum */
166 /* message size the server can send or receive for non-raw SMBs */
167 unsigned int maxRw; /* maxRw specifies the maximum */
168 /* message size the server can send or receive for */
169 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
170 char sessid[4]; /* unique token id for this session */
171 /* (returned on Negotiate */
172 int capabilities; /* allow selective disabling of caps by smb sess */
173 int timeAdj; /* Adjust for difference in server time zone in sec */
174 __u16 CurrentMid; /* multiplex id - rotating counter */
175 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
176 /* 16th byte of RFC1001 workstation name is always null */
177 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
178 __u32 sequence_number; /* needed for CIFS PDU signature */
179 struct mac_key mac_signing_key;
180 char ntlmv2_hash[16];
181 unsigned long lstrp; /* when we got last response from this server */
185 * The following is our shortcut to user information. We surface the uid,
186 * and name. We always get the password on the fly in case it
187 * has changed. We also hang a list of sessions owned by this user off here.
190 struct list_head userList;
191 struct list_head sessionList; /* SMB sessions for this user */
193 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
194 /* BB may need ptr or callback for PAM or WinBind info */
198 * Session structure. One of these for each uid session with a particular host
201 struct list_head smb_ses_list;
202 struct list_head tcon_list;
203 struct semaphore sesSem;
205 struct cifsUidInfo *uidInfo; /* pointer to user info */
207 struct TCP_Server_Info *server; /* pointer to server info */
208 int ses_count; /* reference counter */
209 enum statusEnum status;
210 unsigned overrideSecFlg; /* if non-zero override global sec flags */
211 __u16 ipc_tid; /* special tid for connection to IPC share */
213 char *serverOS; /* name of operating system underlying server */
214 char *serverNOS; /* name of network operating system of server */
215 char *serverDomain; /* security realm of server */
216 int Suid; /* remote smb uid */
217 uid_t linux_uid; /* local Linux uid */
219 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
220 TCP names - will ipv6 and sctp addresses fit? */
221 char userName[MAX_USERNAME_SIZE + 1];
224 bool need_reconnect:1; /* connection reset, uid now invalid */
226 /* no more than one of the following three session flags may be set */
227 #define CIFS_SES_NT4 1
228 #define CIFS_SES_OS2 2
229 #define CIFS_SES_W9X 4
230 /* following flag is set for old servers such as OS2 (and Win95?)
231 which do not negotiate NTLM or POSIX dialects, but instead
232 negotiate one of the older LANMAN dialects */
233 #define CIFS_SES_LANMAN 8
235 * there is one of these for each connection to a resource on a particular
238 struct cifsTconInfo {
239 struct list_head tcon_list;
241 struct list_head openFileList;
242 struct cifsSesInfo *ses; /* pointer to session associated with */
243 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
244 char *nativeFileSystem;
245 char *password; /* for share-level security */
246 __u16 tid; /* The 2 byte tree id */
247 __u16 Flags; /* optional support bits */
248 enum statusEnum tidStatus;
249 #ifdef CONFIG_CIFS_STATS
250 atomic_t num_smbs_sent;
253 atomic_t num_oplock_brks;
256 atomic_t num_deletes;
259 atomic_t num_renames;
260 atomic_t num_t2renames;
264 atomic_t num_hardlinks;
265 atomic_t num_symlinks;
267 atomic_t num_acl_get;
268 atomic_t num_acl_set;
269 #ifdef CONFIG_CIFS_STATS2
270 unsigned long long time_writes;
271 unsigned long long time_reads;
272 unsigned long long time_opens;
273 unsigned long long time_deletes;
274 unsigned long long time_closes;
275 unsigned long long time_mkdirs;
276 unsigned long long time_rmdirs;
277 unsigned long long time_renames;
278 unsigned long long time_t2renames;
279 unsigned long long time_ffirst;
280 unsigned long long time_fnext;
281 unsigned long long time_fclose;
282 #endif /* CONFIG_CIFS_STATS2 */
285 spinlock_t stat_lock;
286 #endif /* CONFIG_CIFS_STATS */
287 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
288 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
289 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
290 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
293 bool seal:1; /* transport encryption for this mounted share */
294 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
295 for this mount even if server would support */
296 bool local_lease:1; /* check leases (only) on local system not remote */
297 bool need_reconnect:1; /* connection reset, tid now invalid */
298 /* BB add field for back pointer to sb struct(s)? */
302 * This info hangs off the cifsFileInfo structure, pointed to by llist.
303 * This is used to track byte stream locks on the file
305 struct cifsLockInfo {
306 struct list_head llist; /* pointer to next cifsLockInfo */
313 * One of these for each open instance of a file
315 struct cifs_search_info {
316 loff_t index_of_last_entry;
317 __u16 entries_in_buffer;
320 char *ntwrk_buf_start;
321 char *srch_entries_start;
324 unsigned int resume_name_len;
328 bool smallBuf:1; /* so we know which buf_release function to call */
331 struct cifsFileInfo {
332 struct list_head tlist; /* pointer to next fid owned by tcon */
333 struct list_head flist; /* next fid (file instance) for this inode */
334 unsigned int uid; /* allows finding which FileInfo structure */
335 __u32 pid; /* process id who opened file */
336 __u16 netfid; /* file id from remote */
337 /* BB add lock scope info here if needed */ ;
338 /* lock scope id (0 if none) */
339 struct file *pfile; /* needed for writepage */
340 struct inode *pInode; /* needed for oplock break */
341 struct mutex lock_mutex;
342 struct list_head llist; /* list of byte range locks we have. */
343 bool closePend:1; /* file is marked to close */
344 bool invalidHandle:1; /* file closed via session abend */
345 bool messageMode:1; /* for pipes: message vs byte mode */
346 atomic_t wrtPending; /* handle in use - defer close */
347 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
348 struct cifs_search_info srch_inf;
352 * One of these for each file inode
355 struct cifsInodeInfo {
356 struct list_head lockList;
357 /* BB add in lists for dirty pages i.e. write caching info for oplock */
358 struct list_head openFileList;
360 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
361 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
362 unsigned long time; /* jiffies of last update/check of inode */
363 bool clientCanCacheRead:1; /* read oplock */
364 bool clientCanCacheAll:1; /* read and writebehind oplock */
365 bool oplockPending:1;
366 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
367 struct inode vfs_inode;
370 static inline struct cifsInodeInfo *
371 CIFS_I(struct inode *inode)
373 return container_of(inode, struct cifsInodeInfo, vfs_inode);
376 static inline struct cifs_sb_info *
377 CIFS_SB(struct super_block *sb)
379 return sb->s_fs_info;
382 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
384 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
390 #ifdef CONFIG_CIFS_STATS
391 #define cifs_stats_inc atomic_inc
393 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
397 spin_lock(&tcon->stat_lock);
398 tcon->bytes_written += bytes;
399 spin_unlock(&tcon->stat_lock);
403 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
406 spin_lock(&tcon->stat_lock);
407 tcon->bytes_read += bytes;
408 spin_unlock(&tcon->stat_lock);
412 #define cifs_stats_inc(field) do {} while (0)
413 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
414 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
418 /* one of these for every pending CIFS request to the server */
420 struct list_head qhead; /* mids waiting on reply from this server */
421 __u16 mid; /* multiplex id */
422 __u16 pid; /* process id */
423 __u32 sequence_number; /* for CIFS signing */
424 unsigned long when_alloc; /* when mid was created */
425 #ifdef CONFIG_CIFS_STATS2
426 unsigned long when_sent; /* time when smb send finished */
427 unsigned long when_received; /* when demux complete (taken off wire) */
429 struct task_struct *tsk; /* task waiting for response */
430 struct smb_hdr *resp_buf; /* response buffer */
431 int midState; /* wish this were enum but can not pass to wait_event */
432 __u8 command; /* smb command code */
433 bool largeBuf:1; /* if valid response, is pointer to large buf */
434 bool multiRsp:1; /* multiple trans2 responses for one request */
435 bool multiEnd:1; /* both received */
438 struct oplock_q_entry {
439 struct list_head qhead;
440 struct inode *pinode;
441 struct cifsTconInfo *tcon;
445 /* for pending dnotify requests */
446 struct dir_notify_req {
447 struct list_head lhead;
454 __u32 filter; /* CompletionFilter (for multishot) */
459 struct dfs_info3_param {
460 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
468 static inline void free_dfs_info_param(struct dfs_info3_param *param)
471 kfree(param->path_name);
472 kfree(param->node_name);
477 static inline void free_dfs_info_array(struct dfs_info3_param *param,
481 if ((number_of_items == 0) || (param == NULL))
483 for (i = 0; i < number_of_items; i++) {
484 kfree(param[i].path_name);
485 kfree(param[i].node_name);
491 #define MID_REQUEST_ALLOCATED 1
492 #define MID_REQUEST_SUBMITTED 2
493 #define MID_RESPONSE_RECEIVED 4
494 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
495 #define MID_NO_RESP_NEEDED 0x10
497 /* Types of response buffer returned from SendReceive2 */
498 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
499 #define CIFS_SMALL_BUFFER 1
500 #define CIFS_LARGE_BUFFER 2
501 #define CIFS_IOVEC 4 /* array of response buffers */
503 /* Type of Request to SendReceive2 */
504 #define CIFS_STD_OP 0 /* normal request timeout */
505 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
506 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
507 #define CIFS_BLOCKING_OP 4 /* operation can block */
508 #define CIFS_ASYNC_OP 8 /* do not wait for response */
509 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
510 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
511 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
512 #define CIFS_NO_RESP 0x040 /* no response buffer required */
514 /* Security Flags: indicate type of session setup needed */
515 #define CIFSSEC_MAY_SIGN 0x00001
516 #define CIFSSEC_MAY_NTLM 0x00002
517 #define CIFSSEC_MAY_NTLMV2 0x00004
518 #define CIFSSEC_MAY_KRB5 0x00008
519 #ifdef CONFIG_CIFS_WEAK_PW_HASH
520 #define CIFSSEC_MAY_LANMAN 0x00010
521 #define CIFSSEC_MAY_PLNTXT 0x00020
523 #define CIFSSEC_MAY_LANMAN 0
524 #define CIFSSEC_MAY_PLNTXT 0
525 #endif /* weak passwords */
526 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
528 #define CIFSSEC_MUST_SIGN 0x01001
529 /* note that only one of the following can be set so the
530 result of setting MUST flags more than once will be to
531 require use of the stronger protocol */
532 #define CIFSSEC_MUST_NTLM 0x02002
533 #define CIFSSEC_MUST_NTLMV2 0x04004
534 #define CIFSSEC_MUST_KRB5 0x08008
535 #ifdef CONFIG_CIFS_WEAK_PW_HASH
536 #define CIFSSEC_MUST_LANMAN 0x10010
537 #define CIFSSEC_MUST_PLNTXT 0x20020
538 #ifdef CONFIG_CIFS_UPCALL
539 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
541 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
543 #else /* do not allow weak pw hash */
544 #ifdef CONFIG_CIFS_UPCALL
545 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
547 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
549 #endif /* WEAK_PW_HASH */
550 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
552 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
553 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
554 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
556 *****************************************************************
557 * All constants go here
558 *****************************************************************
561 #define UID_HASH (16)
564 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
565 * following to be declared.
568 /****************************************************************************
569 * Locking notes. All updates to global variables and lists should be
570 * protected by spinlocks or semaphores.
574 * GlobalMid_Lock protects:
575 * list operations on pending_mid_q and oplockQ
576 * updates to XID counters, multiplex id and SMB sequence numbers
577 * GlobalSMBSesLock protects:
578 * list operations on tcp and SMB session lists and tCon lists
579 * f_owner.lock protects certain per file struct operations
580 * mapping->page_lock protects certain per page operations
584 * sesSem operations on smb session
585 * tconSem operations on tree connection
586 * fh_sem file handle reconnection operations
588 ****************************************************************************/
590 #ifdef DECLARE_GLOBALS_HERE
591 #define GLOBAL_EXTERN
593 #define GLOBAL_EXTERN extern
597 * the list of TCP_Server_Info structures, ie each of the sockets
598 * connecting our client to a distinct server (ip address), is
599 * chained together by cifs_tcp_ses_list. The list of all our SMB
600 * sessions (and from that the tree connections) can be found
601 * by iterating over cifs_tcp_ses_list
603 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
606 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
607 * tcp session, and the list of tcon's per smb session. It also protects
608 * the reference counters for the server, smb session, and tcon. Finally,
609 * changes to the tcon->tidStatus should be done while holding this lock.
611 GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
614 * This lock protects the cifs_file->llist and cifs_file->flist
615 * list operations, and updates to some flags (cifs_file->invalidHandle)
616 * It will be moved to either use the tcon->stat_lock or equivalent later.
617 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
618 * the cifs_tcp_ses_lock must be grabbed first and released last.
620 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
622 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
624 /* Outstanding dir notify requests */
625 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
626 /* DirNotify response queue */
627 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
630 * Global transaction id (XID) information
632 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
633 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
634 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
635 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
636 /* on midQ entries */
637 GLOBAL_EXTERN char Local_System_Name[15];
640 * Global counters, updated atomically
642 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
643 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
644 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
645 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
646 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
648 /* Various Debug counters */
649 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
650 #ifdef CONFIG_CIFS_STATS2
651 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
652 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
654 GLOBAL_EXTERN atomic_t smBufAllocCount;
655 GLOBAL_EXTERN atomic_t midCount;
658 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
659 to be established on existing mount if we
660 have the uid/password or Kerberos credential
661 or equivalent for current user */
662 GLOBAL_EXTERN unsigned int oplockEnabled;
663 GLOBAL_EXTERN unsigned int experimEnabled;
664 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
665 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
666 with more secure ntlmssp2 challenge/resp */
667 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
668 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
669 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
670 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
671 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
672 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/