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 SERVER_NAME_LENGTH 15
51 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
53 /* used to define string lengths for reversing unicode strings */
55 /* (max path length + 1 for null) * 2 for unicode */
60 #ifndef XATTR_DOS_ATTRIB
61 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
65 * CIFS vfs client Status information (based on what we know.)
68 /* associated with each tcp and smb session */
77 PLAINTXT = 0, /* Legacy with Plaintext passwords */
78 LANMAN, /* Legacy LANMAN auth */
79 NTLM, /* Legacy NTLM012 auth with NTLM hash */
80 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
81 RawNTLMSSP, /* NTLMSSP without SPNEGO */
82 NTLMSSP, /* NTLMSSP via SPNEGO */
83 Kerberos, /* Kerberos via SPNEGO */
84 MSKerberos, /* MS Kerberos via SPNEGO */
91 /* Netbios frames protocol not supported at this time */
97 char ntlm[CIFS_SESS_KEY_SIZE + 16];
98 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
101 struct ntlmv2_resp resp;
111 struct cifs_sid osid;
112 struct cifs_sid gsid;
113 struct cifs_ntace *ntaces;
114 struct cifs_ace *aces;
118 *****************************************************************
119 * Except the CIFS PDUs themselves all the
120 * globally interesting structs should go here
121 *****************************************************************
124 struct TCP_Server_Info {
125 /* 15 character server name + 0x20 16th byte indicating type = srv */
126 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
127 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
128 char *hostname; /* hostname portion of UNC string */
129 struct socket *ssocket;
131 struct sockaddr_in sockAddr;
132 struct sockaddr_in6 sockAddr6;
134 wait_queue_head_t response_q;
135 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
136 struct list_head pending_mid_q;
137 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
138 unsigned short server_codepage; /* codepage for the server */
139 unsigned long ip_address; /* IP addr for the server if known */
140 enum protocolEnum protocolType;
143 bool svlocal:1; /* local server or remote */
144 atomic_t socketUseCount; /* number of open cifs sessions on socket */
145 atomic_t inFlight; /* number of requests on the wire to server */
146 #ifdef CONFIG_CIFS_STATS2
147 atomic_t inSend; /* requests trying to send */
148 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
150 enum statusEnum tcpStatus; /* what we think the status is */
151 struct semaphore tcpSem;
152 struct task_struct *tsk;
153 char server_GUID[16];
155 enum securityEnum secType;
156 unsigned int maxReq; /* Clients should submit no more */
157 /* than maxReq distinct unanswered SMBs to the server when using */
158 /* multiplexed reads or writes */
159 unsigned int maxBuf; /* maxBuf specifies the maximum */
160 /* message size the server can send or receive for non-raw SMBs */
161 unsigned int maxRw; /* maxRw specifies the maximum */
162 /* message size the server can send or receive for */
163 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
164 char sessid[4]; /* unique token id for this session */
165 /* (returned on Negotiate */
166 int capabilities; /* allow selective disabling of caps by smb sess */
167 int timeAdj; /* Adjust for difference in server time zone in sec */
168 __u16 CurrentMid; /* multiplex id - rotating counter */
169 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
170 /* 16th byte of RFC1001 workstation name is always null */
171 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
172 __u32 sequence_number; /* needed for CIFS PDU signature */
173 struct mac_key mac_signing_key;
174 char ntlmv2_hash[16];
175 unsigned long lstrp; /* when we got last response from this server */
179 * The following is our shortcut to user information. We surface the uid,
180 * and name. We always get the password on the fly in case it
181 * has changed. We also hang a list of sessions owned by this user off here.
184 struct list_head userList;
185 struct list_head sessionList; /* SMB sessions for this user */
187 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
188 /* BB may need ptr or callback for PAM or WinBind info */
192 * Session structure. One of these for each uid session with a particular host
195 struct list_head cifsSessionList;
196 struct semaphore sesSem;
198 struct cifsUidInfo *uidInfo; /* pointer to user info */
200 struct TCP_Server_Info *server; /* pointer to server info */
201 atomic_t inUse; /* # of mounts (tree connections) on this ses */
202 enum statusEnum status;
203 unsigned overrideSecFlg; /* if non-zero override global sec flags */
204 __u16 ipc_tid; /* special tid for connection to IPC share */
206 char *serverOS; /* name of operating system underlying server */
207 char *serverNOS; /* name of network operating system of server */
208 char *serverDomain; /* security realm of server */
209 int Suid; /* remote smb uid */
210 uid_t linux_uid; /* local Linux uid */
212 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
213 TCP names - will ipv6 and sctp addresses fit? */
214 char userName[MAX_USERNAME_SIZE + 1];
218 /* no more than one of the following three session flags may be set */
219 #define CIFS_SES_NT4 1
220 #define CIFS_SES_OS2 2
221 #define CIFS_SES_W9X 4
222 /* following flag is set for old servers such as OS2 (and Win95?)
223 which do not negotiate NTLM or POSIX dialects, but instead
224 negotiate one of the older LANMAN dialects */
225 #define CIFS_SES_LANMAN 8
227 * there is one of these for each connection to a resource on a particular
230 struct cifsTconInfo {
231 struct list_head cifsConnectionList;
232 struct list_head openFileList;
233 struct semaphore tconSem;
234 struct cifsSesInfo *ses; /* pointer to session associated with */
235 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
236 char *nativeFileSystem;
237 __u16 tid; /* The 2 byte tree id */
238 __u16 Flags; /* optional support bits */
239 enum statusEnum tidStatus;
240 atomic_t useCount; /* how many explicit/implicit mounts to share */
241 #ifdef CONFIG_CIFS_STATS
242 atomic_t num_smbs_sent;
245 atomic_t num_oplock_brks;
248 atomic_t num_deletes;
251 atomic_t num_renames;
252 atomic_t num_t2renames;
256 atomic_t num_hardlinks;
257 atomic_t num_symlinks;
259 atomic_t num_acl_get;
260 atomic_t num_acl_set;
261 #ifdef CONFIG_CIFS_STATS2
262 unsigned long long time_writes;
263 unsigned long long time_reads;
264 unsigned long long time_opens;
265 unsigned long long time_deletes;
266 unsigned long long time_closes;
267 unsigned long long time_mkdirs;
268 unsigned long long time_rmdirs;
269 unsigned long long time_renames;
270 unsigned long long time_t2renames;
271 unsigned long long time_ffirst;
272 unsigned long long time_fnext;
273 unsigned long long time_fclose;
274 #endif /* CONFIG_CIFS_STATS2 */
277 spinlock_t stat_lock;
278 #endif /* CONFIG_CIFS_STATS */
279 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
280 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
281 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
282 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
285 bool seal:1; /* transport encryption for this mounted share */
286 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
287 for this mount even if server would support */
288 /* BB add field for back pointer to sb struct(s)? */
292 * This info hangs off the cifsFileInfo structure, pointed to by llist.
293 * This is used to track byte stream locks on the file
295 struct cifsLockInfo {
296 struct list_head llist; /* pointer to next cifsLockInfo */
303 * One of these for each open instance of a file
305 struct cifs_search_info {
306 loff_t index_of_last_entry;
307 __u16 entries_in_buffer;
310 char *ntwrk_buf_start;
311 char *srch_entries_start;
314 unsigned int resume_name_len;
318 bool smallBuf:1; /* so we know which buf_release function to call */
321 struct cifsFileInfo {
322 struct list_head tlist; /* pointer to next fid owned by tcon */
323 struct list_head flist; /* next fid (file instance) for this inode */
324 unsigned int uid; /* allows finding which FileInfo structure */
325 __u32 pid; /* process id who opened file */
326 __u16 netfid; /* file id from remote */
327 /* BB add lock scope info here if needed */ ;
328 /* lock scope id (0 if none) */
329 struct file *pfile; /* needed for writepage */
330 struct inode *pInode; /* needed for oplock break */
331 struct mutex lock_mutex;
332 struct list_head llist; /* list of byte range locks we have. */
333 bool closePend:1; /* file is marked to close */
334 bool invalidHandle:1; /* file closed via session abend */
335 bool messageMode:1; /* for pipes: message vs byte mode */
336 atomic_t wrtPending; /* handle in use - defer close */
337 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
338 struct cifs_search_info srch_inf;
342 * One of these for each file inode
345 struct cifsInodeInfo {
346 struct list_head lockList;
347 /* BB add in lists for dirty pages i.e. write caching info for oplock */
348 struct list_head openFileList;
350 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
351 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
352 unsigned long time; /* jiffies of last update/check of inode */
353 bool clientCanCacheRead:1; /* read oplock */
354 bool clientCanCacheAll:1; /* read and writebehind oplock */
355 bool oplockPending:1;
356 struct inode vfs_inode;
359 static inline struct cifsInodeInfo *
360 CIFS_I(struct inode *inode)
362 return container_of(inode, struct cifsInodeInfo, vfs_inode);
365 static inline struct cifs_sb_info *
366 CIFS_SB(struct super_block *sb)
368 return sb->s_fs_info;
371 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
373 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
379 #ifdef CONFIG_CIFS_STATS
380 #define cifs_stats_inc atomic_inc
382 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
386 spin_lock(&tcon->stat_lock);
387 tcon->bytes_written += bytes;
388 spin_unlock(&tcon->stat_lock);
392 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
395 spin_lock(&tcon->stat_lock);
396 tcon->bytes_read += bytes;
397 spin_unlock(&tcon->stat_lock);
401 #define cifs_stats_inc(field) do {} while (0)
402 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
403 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
407 /* one of these for every pending CIFS request to the server */
409 struct list_head qhead; /* mids waiting on reply from this server */
410 __u16 mid; /* multiplex id */
411 __u16 pid; /* process id */
412 __u32 sequence_number; /* for CIFS signing */
413 unsigned long when_alloc; /* when mid was created */
414 #ifdef CONFIG_CIFS_STATS2
415 unsigned long when_sent; /* time when smb send finished */
416 unsigned long when_received; /* when demux complete (taken off wire) */
418 struct cifsSesInfo *ses; /* smb was sent to this server */
419 struct task_struct *tsk; /* task waiting for response */
420 struct smb_hdr *resp_buf; /* response buffer */
421 int midState; /* wish this were enum but can not pass to wait_event */
422 __u8 command; /* smb command code */
423 bool largeBuf:1; /* if valid response, is pointer to large buf */
424 bool multiRsp:1; /* multiple trans2 responses for one request */
425 bool multiEnd:1; /* both received */
428 struct oplock_q_entry {
429 struct list_head qhead;
430 struct inode *pinode;
431 struct cifsTconInfo *tcon;
435 /* for pending dnotify requests */
436 struct dir_notify_req {
437 struct list_head lhead;
444 __u32 filter; /* CompletionFilter (for multishot) */
449 struct dfs_info3_param {
450 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
458 static inline void free_dfs_info_param(struct dfs_info3_param *param)
461 kfree(param->path_name);
462 kfree(param->node_name);
467 static inline void free_dfs_info_array(struct dfs_info3_param *param,
471 if ((number_of_items == 0) || (param == NULL))
473 for (i = 0; i < number_of_items; i++) {
474 kfree(param[i].path_name);
475 kfree(param[i].node_name);
481 #define MID_REQUEST_ALLOCATED 1
482 #define MID_REQUEST_SUBMITTED 2
483 #define MID_RESPONSE_RECEIVED 4
484 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
485 #define MID_NO_RESP_NEEDED 0x10
487 /* Types of response buffer returned from SendReceive2 */
488 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
489 #define CIFS_SMALL_BUFFER 1
490 #define CIFS_LARGE_BUFFER 2
491 #define CIFS_IOVEC 4 /* array of response buffers */
493 /* Type of Request to SendReceive2 */
494 #define CIFS_STD_OP 0 /* normal request timeout */
495 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
496 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
497 #define CIFS_BLOCKING_OP 4 /* operation can block */
498 #define CIFS_ASYNC_OP 8 /* do not wait for response */
499 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
500 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
501 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
502 #define CIFS_NO_RESP 0x040 /* no response buffer required */
504 /* Security Flags: indicate type of session setup needed */
505 #define CIFSSEC_MAY_SIGN 0x00001
506 #define CIFSSEC_MAY_NTLM 0x00002
507 #define CIFSSEC_MAY_NTLMV2 0x00004
508 #define CIFSSEC_MAY_KRB5 0x00008
509 #ifdef CONFIG_CIFS_WEAK_PW_HASH
510 #define CIFSSEC_MAY_LANMAN 0x00010
511 #define CIFSSEC_MAY_PLNTXT 0x00020
513 #define CIFSSEC_MAY_LANMAN 0
514 #define CIFSSEC_MAY_PLNTXT 0
515 #endif /* weak passwords */
516 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
518 #define CIFSSEC_MUST_SIGN 0x01001
519 /* note that only one of the following can be set so the
520 result of setting MUST flags more than once will be to
521 require use of the stronger protocol */
522 #define CIFSSEC_MUST_NTLM 0x02002
523 #define CIFSSEC_MUST_NTLMV2 0x04004
524 #define CIFSSEC_MUST_KRB5 0x08008
525 #ifdef CONFIG_CIFS_WEAK_PW_HASH
526 #define CIFSSEC_MUST_LANMAN 0x10010
527 #define CIFSSEC_MUST_PLNTXT 0x20020
528 #ifdef CONFIG_CIFS_UPCALL
529 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
531 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
533 #else /* do not allow weak pw hash */
534 #ifdef CONFIG_CIFS_UPCALL
535 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
537 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
539 #endif /* WEAK_PW_HASH */
540 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
542 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
543 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
544 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
546 *****************************************************************
547 * All constants go here
548 *****************************************************************
551 #define UID_HASH (16)
554 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
555 * following to be declared.
558 /****************************************************************************
559 * Locking notes. All updates to global variables and lists should be
560 * protected by spinlocks or semaphores.
564 * GlobalMid_Lock protects:
565 * list operations on pending_mid_q and oplockQ
566 * updates to XID counters, multiplex id and SMB sequence numbers
567 * GlobalSMBSesLock protects:
568 * list operations on tcp and SMB session lists and tCon lists
569 * f_owner.lock protects certain per file struct operations
570 * mapping->page_lock protects certain per page operations
574 * sesSem operations on smb session
575 * tconSem operations on tree connection
576 * fh_sem file handle reconnection operations
578 ****************************************************************************/
580 #ifdef DECLARE_GLOBALS_HERE
581 #define GLOBAL_EXTERN
583 #define GLOBAL_EXTERN extern
587 * The list of servers that did not respond with NT LM 0.12.
588 * This list helps improve performance and eliminate the messages indicating
589 * that we had a communications error talking to the server in this list.
591 /* Feature not supported */
592 /* GLOBAL_EXTERN struct servers_not_supported *NotSuppList; */
595 * The following is a hash table of all the users we know about.
597 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
599 /* GLOBAL_EXTERN struct list_head GlobalServerList; BB not implemented yet */
600 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
601 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
602 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
604 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
606 /* Outstanding dir notify requests */
607 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
608 /* DirNotify response queue */
609 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
612 * Global transaction id (XID) information
614 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
615 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
616 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
617 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
618 /* on midQ entries */
619 GLOBAL_EXTERN char Local_System_Name[15];
622 * Global counters, updated atomically
624 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
625 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
626 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
627 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
628 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
630 /* Various Debug counters */
631 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
632 #ifdef CONFIG_CIFS_STATS2
633 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
634 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
636 GLOBAL_EXTERN atomic_t smBufAllocCount;
637 GLOBAL_EXTERN atomic_t midCount;
640 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
641 to be established on existing mount if we
642 have the uid/password or Kerberos credential
643 or equivalent for current user */
644 GLOBAL_EXTERN unsigned int oplockEnabled;
645 GLOBAL_EXTERN unsigned int experimEnabled;
646 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
647 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
648 with more secure ntlmssp2 challenge/resp */
649 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
650 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
651 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
652 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
653 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
654 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/