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 bool noblocksnd; /* use blocking sendmsg */
145 bool noautotune; /* do not autotune send buf sizes */
146 atomic_t socketUseCount; /* number of open cifs sessions on socket */
147 atomic_t inFlight; /* number of requests on the wire to server */
148 #ifdef CONFIG_CIFS_STATS2
149 atomic_t inSend; /* requests trying to send */
150 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
152 enum statusEnum tcpStatus; /* what we think the status is */
153 struct semaphore tcpSem;
154 struct task_struct *tsk;
155 char server_GUID[16];
157 enum securityEnum secType;
158 unsigned int maxReq; /* Clients should submit no more */
159 /* than maxReq distinct unanswered SMBs to the server when using */
160 /* multiplexed reads or writes */
161 unsigned int maxBuf; /* maxBuf specifies the maximum */
162 /* message size the server can send or receive for non-raw SMBs */
163 unsigned int maxRw; /* maxRw specifies the maximum */
164 /* message size the server can send or receive for */
165 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
166 char sessid[4]; /* unique token id for this session */
167 /* (returned on Negotiate */
168 int capabilities; /* allow selective disabling of caps by smb sess */
169 int timeAdj; /* Adjust for difference in server time zone in sec */
170 __u16 CurrentMid; /* multiplex id - rotating counter */
171 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
172 /* 16th byte of RFC1001 workstation name is always null */
173 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
174 __u32 sequence_number; /* needed for CIFS PDU signature */
175 struct mac_key mac_signing_key;
176 char ntlmv2_hash[16];
177 unsigned long lstrp; /* when we got last response from this server */
181 * The following is our shortcut to user information. We surface the uid,
182 * and name. We always get the password on the fly in case it
183 * has changed. We also hang a list of sessions owned by this user off here.
186 struct list_head userList;
187 struct list_head sessionList; /* SMB sessions for this user */
189 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
190 /* BB may need ptr or callback for PAM or WinBind info */
194 * Session structure. One of these for each uid session with a particular host
197 struct list_head cifsSessionList;
198 struct semaphore sesSem;
200 struct cifsUidInfo *uidInfo; /* pointer to user info */
202 struct TCP_Server_Info *server; /* pointer to server info */
203 atomic_t inUse; /* # of mounts (tree connections) on this ses */
204 enum statusEnum status;
205 unsigned overrideSecFlg; /* if non-zero override global sec flags */
206 __u16 ipc_tid; /* special tid for connection to IPC share */
208 char *serverOS; /* name of operating system underlying server */
209 char *serverNOS; /* name of network operating system of server */
210 char *serverDomain; /* security realm of server */
211 int Suid; /* remote smb uid */
212 uid_t linux_uid; /* local Linux uid */
214 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
215 TCP names - will ipv6 and sctp addresses fit? */
216 char userName[MAX_USERNAME_SIZE + 1];
220 /* no more than one of the following three session flags may be set */
221 #define CIFS_SES_NT4 1
222 #define CIFS_SES_OS2 2
223 #define CIFS_SES_W9X 4
224 /* following flag is set for old servers such as OS2 (and Win95?)
225 which do not negotiate NTLM or POSIX dialects, but instead
226 negotiate one of the older LANMAN dialects */
227 #define CIFS_SES_LANMAN 8
229 * there is one of these for each connection to a resource on a particular
232 struct cifsTconInfo {
233 struct list_head cifsConnectionList;
234 struct list_head openFileList;
235 struct semaphore tconSem;
236 struct cifsSesInfo *ses; /* pointer to session associated with */
237 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
238 char *nativeFileSystem;
239 __u16 tid; /* The 2 byte tree id */
240 __u16 Flags; /* optional support bits */
241 enum statusEnum tidStatus;
242 atomic_t useCount; /* how many explicit/implicit mounts to share */
243 #ifdef CONFIG_CIFS_STATS
244 atomic_t num_smbs_sent;
247 atomic_t num_oplock_brks;
250 atomic_t num_deletes;
253 atomic_t num_renames;
254 atomic_t num_t2renames;
258 atomic_t num_hardlinks;
259 atomic_t num_symlinks;
261 atomic_t num_acl_get;
262 atomic_t num_acl_set;
263 #ifdef CONFIG_CIFS_STATS2
264 unsigned long long time_writes;
265 unsigned long long time_reads;
266 unsigned long long time_opens;
267 unsigned long long time_deletes;
268 unsigned long long time_closes;
269 unsigned long long time_mkdirs;
270 unsigned long long time_rmdirs;
271 unsigned long long time_renames;
272 unsigned long long time_t2renames;
273 unsigned long long time_ffirst;
274 unsigned long long time_fnext;
275 unsigned long long time_fclose;
276 #endif /* CONFIG_CIFS_STATS2 */
279 spinlock_t stat_lock;
280 #endif /* CONFIG_CIFS_STATS */
281 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
282 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
283 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
284 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
287 bool seal:1; /* transport encryption for this mounted share */
288 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
289 for this mount even if server would support */
290 bool local_lease:1; /* check leases (only) on local system not remote */
291 /* BB add field for back pointer to sb struct(s)? */
295 * This info hangs off the cifsFileInfo structure, pointed to by llist.
296 * This is used to track byte stream locks on the file
298 struct cifsLockInfo {
299 struct list_head llist; /* pointer to next cifsLockInfo */
306 * One of these for each open instance of a file
308 struct cifs_search_info {
309 loff_t index_of_last_entry;
310 __u16 entries_in_buffer;
313 char *ntwrk_buf_start;
314 char *srch_entries_start;
317 unsigned int resume_name_len;
321 bool smallBuf:1; /* so we know which buf_release function to call */
324 struct cifsFileInfo {
325 struct list_head tlist; /* pointer to next fid owned by tcon */
326 struct list_head flist; /* next fid (file instance) for this inode */
327 unsigned int uid; /* allows finding which FileInfo structure */
328 __u32 pid; /* process id who opened file */
329 __u16 netfid; /* file id from remote */
330 /* BB add lock scope info here if needed */ ;
331 /* lock scope id (0 if none) */
332 struct file *pfile; /* needed for writepage */
333 struct inode *pInode; /* needed for oplock break */
334 struct mutex lock_mutex;
335 struct list_head llist; /* list of byte range locks we have. */
336 bool closePend:1; /* file is marked to close */
337 bool invalidHandle:1; /* file closed via session abend */
338 bool messageMode:1; /* for pipes: message vs byte mode */
339 atomic_t wrtPending; /* handle in use - defer close */
340 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
341 struct cifs_search_info srch_inf;
345 * One of these for each file inode
348 struct cifsInodeInfo {
349 struct list_head lockList;
350 /* BB add in lists for dirty pages i.e. write caching info for oplock */
351 struct list_head openFileList;
353 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
354 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
355 unsigned long time; /* jiffies of last update/check of inode */
356 bool clientCanCacheRead:1; /* read oplock */
357 bool clientCanCacheAll:1; /* read and writebehind oplock */
358 bool oplockPending:1;
359 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
360 struct inode vfs_inode;
363 static inline struct cifsInodeInfo *
364 CIFS_I(struct inode *inode)
366 return container_of(inode, struct cifsInodeInfo, vfs_inode);
369 static inline struct cifs_sb_info *
370 CIFS_SB(struct super_block *sb)
372 return sb->s_fs_info;
375 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
377 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
383 #ifdef CONFIG_CIFS_STATS
384 #define cifs_stats_inc atomic_inc
386 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
390 spin_lock(&tcon->stat_lock);
391 tcon->bytes_written += bytes;
392 spin_unlock(&tcon->stat_lock);
396 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
399 spin_lock(&tcon->stat_lock);
400 tcon->bytes_read += bytes;
401 spin_unlock(&tcon->stat_lock);
405 #define cifs_stats_inc(field) do {} while (0)
406 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
407 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
411 /* one of these for every pending CIFS request to the server */
413 struct list_head qhead; /* mids waiting on reply from this server */
414 __u16 mid; /* multiplex id */
415 __u16 pid; /* process id */
416 __u32 sequence_number; /* for CIFS signing */
417 unsigned long when_alloc; /* when mid was created */
418 #ifdef CONFIG_CIFS_STATS2
419 unsigned long when_sent; /* time when smb send finished */
420 unsigned long when_received; /* when demux complete (taken off wire) */
422 struct cifsSesInfo *ses; /* smb was sent to this server */
423 struct task_struct *tsk; /* task waiting for response */
424 struct smb_hdr *resp_buf; /* response buffer */
425 int midState; /* wish this were enum but can not pass to wait_event */
426 __u8 command; /* smb command code */
427 bool largeBuf:1; /* if valid response, is pointer to large buf */
428 bool multiRsp:1; /* multiple trans2 responses for one request */
429 bool multiEnd:1; /* both received */
432 struct oplock_q_entry {
433 struct list_head qhead;
434 struct inode *pinode;
435 struct cifsTconInfo *tcon;
439 /* for pending dnotify requests */
440 struct dir_notify_req {
441 struct list_head lhead;
448 __u32 filter; /* CompletionFilter (for multishot) */
453 struct dfs_info3_param {
454 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
462 static inline void free_dfs_info_param(struct dfs_info3_param *param)
465 kfree(param->path_name);
466 kfree(param->node_name);
471 static inline void free_dfs_info_array(struct dfs_info3_param *param,
475 if ((number_of_items == 0) || (param == NULL))
477 for (i = 0; i < number_of_items; i++) {
478 kfree(param[i].path_name);
479 kfree(param[i].node_name);
485 #define MID_REQUEST_ALLOCATED 1
486 #define MID_REQUEST_SUBMITTED 2
487 #define MID_RESPONSE_RECEIVED 4
488 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
489 #define MID_NO_RESP_NEEDED 0x10
491 /* Types of response buffer returned from SendReceive2 */
492 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
493 #define CIFS_SMALL_BUFFER 1
494 #define CIFS_LARGE_BUFFER 2
495 #define CIFS_IOVEC 4 /* array of response buffers */
497 /* Type of Request to SendReceive2 */
498 #define CIFS_STD_OP 0 /* normal request timeout */
499 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
500 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
501 #define CIFS_BLOCKING_OP 4 /* operation can block */
502 #define CIFS_ASYNC_OP 8 /* do not wait for response */
503 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
504 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
505 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
506 #define CIFS_NO_RESP 0x040 /* no response buffer required */
508 /* Security Flags: indicate type of session setup needed */
509 #define CIFSSEC_MAY_SIGN 0x00001
510 #define CIFSSEC_MAY_NTLM 0x00002
511 #define CIFSSEC_MAY_NTLMV2 0x00004
512 #define CIFSSEC_MAY_KRB5 0x00008
513 #ifdef CONFIG_CIFS_WEAK_PW_HASH
514 #define CIFSSEC_MAY_LANMAN 0x00010
515 #define CIFSSEC_MAY_PLNTXT 0x00020
517 #define CIFSSEC_MAY_LANMAN 0
518 #define CIFSSEC_MAY_PLNTXT 0
519 #endif /* weak passwords */
520 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
522 #define CIFSSEC_MUST_SIGN 0x01001
523 /* note that only one of the following can be set so the
524 result of setting MUST flags more than once will be to
525 require use of the stronger protocol */
526 #define CIFSSEC_MUST_NTLM 0x02002
527 #define CIFSSEC_MUST_NTLMV2 0x04004
528 #define CIFSSEC_MUST_KRB5 0x08008
529 #ifdef CONFIG_CIFS_WEAK_PW_HASH
530 #define CIFSSEC_MUST_LANMAN 0x10010
531 #define CIFSSEC_MUST_PLNTXT 0x20020
532 #ifdef CONFIG_CIFS_UPCALL
533 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
535 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
537 #else /* do not allow weak pw hash */
538 #ifdef CONFIG_CIFS_UPCALL
539 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
541 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
543 #endif /* WEAK_PW_HASH */
544 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
546 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
547 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
548 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
550 *****************************************************************
551 * All constants go here
552 *****************************************************************
555 #define UID_HASH (16)
558 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
559 * following to be declared.
562 /****************************************************************************
563 * Locking notes. All updates to global variables and lists should be
564 * protected by spinlocks or semaphores.
568 * GlobalMid_Lock protects:
569 * list operations on pending_mid_q and oplockQ
570 * updates to XID counters, multiplex id and SMB sequence numbers
571 * GlobalSMBSesLock protects:
572 * list operations on tcp and SMB session lists and tCon lists
573 * f_owner.lock protects certain per file struct operations
574 * mapping->page_lock protects certain per page operations
578 * sesSem operations on smb session
579 * tconSem operations on tree connection
580 * fh_sem file handle reconnection operations
582 ****************************************************************************/
584 #ifdef DECLARE_GLOBALS_HERE
585 #define GLOBAL_EXTERN
587 #define GLOBAL_EXTERN extern
591 * The list of servers that did not respond with NT LM 0.12.
592 * This list helps improve performance and eliminate the messages indicating
593 * that we had a communications error talking to the server in this list.
595 /* Feature not supported */
596 /* GLOBAL_EXTERN struct servers_not_supported *NotSuppList; */
599 * The following is a hash table of all the users we know about.
601 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
603 /* GLOBAL_EXTERN struct list_head GlobalServerList; BB not implemented yet */
604 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
605 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
606 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
608 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
610 /* Outstanding dir notify requests */
611 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
612 /* DirNotify response queue */
613 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
616 * Global transaction id (XID) information
618 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
619 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
620 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
621 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
622 /* on midQ entries */
623 GLOBAL_EXTERN char Local_System_Name[15];
626 * Global counters, updated atomically
628 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
629 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
630 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
631 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
632 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
634 /* Various Debug counters */
635 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
636 #ifdef CONFIG_CIFS_STATS2
637 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
638 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
640 GLOBAL_EXTERN atomic_t smBufAllocCount;
641 GLOBAL_EXTERN atomic_t midCount;
644 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
645 to be established on existing mount if we
646 have the uid/password or Kerberos credential
647 or equivalent for current user */
648 GLOBAL_EXTERN unsigned int oplockEnabled;
649 GLOBAL_EXTERN unsigned int experimEnabled;
650 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
651 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
652 with more secure ntlmssp2 challenge/resp */
653 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
654 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
655 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
656 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
657 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
658 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/