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