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 */
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 struct list_head tcp_ses_list;
125 struct list_head smb_ses_list;
126 /* 15 character server name + 0x20 16th byte indicating type = srv */
127 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
128 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
129 char *hostname; /* hostname portion of UNC string */
130 struct socket *ssocket;
132 struct sockaddr_in sockAddr;
133 struct sockaddr_in6 sockAddr6;
135 wait_queue_head_t response_q;
136 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
137 struct list_head pending_mid_q;
138 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
139 unsigned short server_codepage; /* codepage for the server */
140 unsigned long ip_address; /* IP addr for the server if known */
141 enum protocolEnum protocolType;
144 bool svlocal:1; /* local server or remote */
145 bool noblocksnd; /* use blocking sendmsg */
146 bool noautotune; /* do not autotune send buf sizes */
147 atomic_t socketUseCount; /* number of open cifs sessions on socket */
148 atomic_t inFlight; /* number of requests on the wire to server */
149 #ifdef CONFIG_CIFS_STATS2
150 atomic_t inSend; /* requests trying to send */
151 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
153 enum statusEnum tcpStatus; /* what we think the status is */
154 struct semaphore tcpSem;
155 struct task_struct *tsk;
156 char server_GUID[16];
158 enum securityEnum secType;
159 unsigned int maxReq; /* Clients should submit no more */
160 /* than maxReq distinct unanswered SMBs to the server when using */
161 /* multiplexed reads or writes */
162 unsigned int maxBuf; /* maxBuf specifies the maximum */
163 /* message size the server can send or receive for non-raw SMBs */
164 unsigned int maxRw; /* maxRw specifies the maximum */
165 /* message size the server can send or receive for */
166 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
167 char sessid[4]; /* unique token id for this session */
168 /* (returned on Negotiate */
169 int capabilities; /* allow selective disabling of caps by smb sess */
170 int timeAdj; /* Adjust for difference in server time zone in sec */
171 __u16 CurrentMid; /* multiplex id - rotating counter */
172 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
173 /* 16th byte of RFC1001 workstation name is always null */
174 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
175 __u32 sequence_number; /* needed for CIFS PDU signature */
176 struct mac_key mac_signing_key;
177 char ntlmv2_hash[16];
178 unsigned long lstrp; /* when we got last response from this server */
182 * The following is our shortcut to user information. We surface the uid,
183 * and name. We always get the password on the fly in case it
184 * has changed. We also hang a list of sessions owned by this user off here.
187 struct list_head userList;
188 struct list_head sessionList; /* SMB sessions for this user */
190 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
191 /* BB may need ptr or callback for PAM or WinBind info */
195 * Session structure. One of these for each uid session with a particular host
198 struct list_head cifsSessionList;
199 struct list_head tcon_list;
200 struct semaphore sesSem;
202 struct cifsUidInfo *uidInfo; /* pointer to user info */
204 struct TCP_Server_Info *server; /* pointer to server info */
205 atomic_t inUse; /* # of mounts (tree connections) on this ses */
206 enum statusEnum status;
207 unsigned overrideSecFlg; /* if non-zero override global sec flags */
208 __u16 ipc_tid; /* special tid for connection to IPC share */
210 char *serverOS; /* name of operating system underlying server */
211 char *serverNOS; /* name of network operating system of server */
212 char *serverDomain; /* security realm of server */
213 int Suid; /* remote smb uid */
214 uid_t linux_uid; /* local Linux uid */
216 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
217 TCP names - will ipv6 and sctp addresses fit? */
218 char userName[MAX_USERNAME_SIZE + 1];
221 bool need_reconnect:1; /* connection reset, uid now invalid */
223 /* no more than one of the following three session flags may be set */
224 #define CIFS_SES_NT4 1
225 #define CIFS_SES_OS2 2
226 #define CIFS_SES_W9X 4
227 /* following flag is set for old servers such as OS2 (and Win95?)
228 which do not negotiate NTLM or POSIX dialects, but instead
229 negotiate one of the older LANMAN dialects */
230 #define CIFS_SES_LANMAN 8
232 * there is one of these for each connection to a resource on a particular
235 struct cifsTconInfo {
236 struct list_head cifsConnectionList;
237 struct list_head openFileList;
238 struct semaphore tconSem;
239 struct cifsSesInfo *ses; /* pointer to session associated with */
240 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
241 char *nativeFileSystem;
242 __u16 tid; /* The 2 byte tree id */
243 __u16 Flags; /* optional support bits */
244 enum statusEnum tidStatus;
245 atomic_t useCount; /* how many explicit/implicit mounts to share */
246 #ifdef CONFIG_CIFS_STATS
247 atomic_t num_smbs_sent;
250 atomic_t num_oplock_brks;
253 atomic_t num_deletes;
256 atomic_t num_renames;
257 atomic_t num_t2renames;
261 atomic_t num_hardlinks;
262 atomic_t num_symlinks;
264 atomic_t num_acl_get;
265 atomic_t num_acl_set;
266 #ifdef CONFIG_CIFS_STATS2
267 unsigned long long time_writes;
268 unsigned long long time_reads;
269 unsigned long long time_opens;
270 unsigned long long time_deletes;
271 unsigned long long time_closes;
272 unsigned long long time_mkdirs;
273 unsigned long long time_rmdirs;
274 unsigned long long time_renames;
275 unsigned long long time_t2renames;
276 unsigned long long time_ffirst;
277 unsigned long long time_fnext;
278 unsigned long long time_fclose;
279 #endif /* CONFIG_CIFS_STATS2 */
282 spinlock_t stat_lock;
283 #endif /* CONFIG_CIFS_STATS */
284 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
285 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
286 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
287 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
290 bool seal:1; /* transport encryption for this mounted share */
291 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
292 for this mount even if server would support */
293 bool local_lease:1; /* check leases (only) on local system not remote */
294 bool need_reconnect:1; /* connection reset, tid now invalid */
295 /* BB add field for back pointer to sb struct(s)? */
299 * This info hangs off the cifsFileInfo structure, pointed to by llist.
300 * This is used to track byte stream locks on the file
302 struct cifsLockInfo {
303 struct list_head llist; /* pointer to next cifsLockInfo */
310 * One of these for each open instance of a file
312 struct cifs_search_info {
313 loff_t index_of_last_entry;
314 __u16 entries_in_buffer;
317 char *ntwrk_buf_start;
318 char *srch_entries_start;
321 unsigned int resume_name_len;
325 bool smallBuf:1; /* so we know which buf_release function to call */
328 struct cifsFileInfo {
329 struct list_head tlist; /* pointer to next fid owned by tcon */
330 struct list_head flist; /* next fid (file instance) for this inode */
331 unsigned int uid; /* allows finding which FileInfo structure */
332 __u32 pid; /* process id who opened file */
333 __u16 netfid; /* file id from remote */
334 /* BB add lock scope info here if needed */ ;
335 /* lock scope id (0 if none) */
336 struct file *pfile; /* needed for writepage */
337 struct inode *pInode; /* needed for oplock break */
338 struct mutex lock_mutex;
339 struct list_head llist; /* list of byte range locks we have. */
340 bool closePend:1; /* file is marked to close */
341 bool invalidHandle:1; /* file closed via session abend */
342 bool messageMode:1; /* for pipes: message vs byte mode */
343 atomic_t wrtPending; /* handle in use - defer close */
344 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
345 struct cifs_search_info srch_inf;
349 * One of these for each file inode
352 struct cifsInodeInfo {
353 struct list_head lockList;
354 /* BB add in lists for dirty pages i.e. write caching info for oplock */
355 struct list_head openFileList;
357 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
358 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
359 unsigned long time; /* jiffies of last update/check of inode */
360 bool clientCanCacheRead:1; /* read oplock */
361 bool clientCanCacheAll:1; /* read and writebehind oplock */
362 bool oplockPending:1;
363 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
364 struct inode vfs_inode;
367 static inline struct cifsInodeInfo *
368 CIFS_I(struct inode *inode)
370 return container_of(inode, struct cifsInodeInfo, vfs_inode);
373 static inline struct cifs_sb_info *
374 CIFS_SB(struct super_block *sb)
376 return sb->s_fs_info;
379 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
381 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
387 #ifdef CONFIG_CIFS_STATS
388 #define cifs_stats_inc atomic_inc
390 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
394 spin_lock(&tcon->stat_lock);
395 tcon->bytes_written += bytes;
396 spin_unlock(&tcon->stat_lock);
400 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
403 spin_lock(&tcon->stat_lock);
404 tcon->bytes_read += bytes;
405 spin_unlock(&tcon->stat_lock);
409 #define cifs_stats_inc(field) do {} while (0)
410 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
411 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
415 /* one of these for every pending CIFS request to the server */
417 struct list_head qhead; /* mids waiting on reply from this server */
418 __u16 mid; /* multiplex id */
419 __u16 pid; /* process id */
420 __u32 sequence_number; /* for CIFS signing */
421 unsigned long when_alloc; /* when mid was created */
422 #ifdef CONFIG_CIFS_STATS2
423 unsigned long when_sent; /* time when smb send finished */
424 unsigned long when_received; /* when demux complete (taken off wire) */
426 struct cifsSesInfo *ses; /* smb was sent to this server */
427 struct task_struct *tsk; /* task waiting for response */
428 struct smb_hdr *resp_buf; /* response buffer */
429 int midState; /* wish this were enum but can not pass to wait_event */
430 __u8 command; /* smb command code */
431 bool largeBuf:1; /* if valid response, is pointer to large buf */
432 bool multiRsp:1; /* multiple trans2 responses for one request */
433 bool multiEnd:1; /* both received */
436 struct oplock_q_entry {
437 struct list_head qhead;
438 struct inode *pinode;
439 struct cifsTconInfo *tcon;
443 /* for pending dnotify requests */
444 struct dir_notify_req {
445 struct list_head lhead;
452 __u32 filter; /* CompletionFilter (for multishot) */
457 struct dfs_info3_param {
458 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
466 static inline void free_dfs_info_param(struct dfs_info3_param *param)
469 kfree(param->path_name);
470 kfree(param->node_name);
475 static inline void free_dfs_info_array(struct dfs_info3_param *param,
479 if ((number_of_items == 0) || (param == NULL))
481 for (i = 0; i < number_of_items; i++) {
482 kfree(param[i].path_name);
483 kfree(param[i].node_name);
489 #define MID_REQUEST_ALLOCATED 1
490 #define MID_REQUEST_SUBMITTED 2
491 #define MID_RESPONSE_RECEIVED 4
492 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
493 #define MID_NO_RESP_NEEDED 0x10
495 /* Types of response buffer returned from SendReceive2 */
496 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
497 #define CIFS_SMALL_BUFFER 1
498 #define CIFS_LARGE_BUFFER 2
499 #define CIFS_IOVEC 4 /* array of response buffers */
501 /* Type of Request to SendReceive2 */
502 #define CIFS_STD_OP 0 /* normal request timeout */
503 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
504 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
505 #define CIFS_BLOCKING_OP 4 /* operation can block */
506 #define CIFS_ASYNC_OP 8 /* do not wait for response */
507 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
508 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
509 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
510 #define CIFS_NO_RESP 0x040 /* no response buffer required */
512 /* Security Flags: indicate type of session setup needed */
513 #define CIFSSEC_MAY_SIGN 0x00001
514 #define CIFSSEC_MAY_NTLM 0x00002
515 #define CIFSSEC_MAY_NTLMV2 0x00004
516 #define CIFSSEC_MAY_KRB5 0x00008
517 #ifdef CONFIG_CIFS_WEAK_PW_HASH
518 #define CIFSSEC_MAY_LANMAN 0x00010
519 #define CIFSSEC_MAY_PLNTXT 0x00020
521 #define CIFSSEC_MAY_LANMAN 0
522 #define CIFSSEC_MAY_PLNTXT 0
523 #endif /* weak passwords */
524 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
526 #define CIFSSEC_MUST_SIGN 0x01001
527 /* note that only one of the following can be set so the
528 result of setting MUST flags more than once will be to
529 require use of the stronger protocol */
530 #define CIFSSEC_MUST_NTLM 0x02002
531 #define CIFSSEC_MUST_NTLMV2 0x04004
532 #define CIFSSEC_MUST_KRB5 0x08008
533 #ifdef CONFIG_CIFS_WEAK_PW_HASH
534 #define CIFSSEC_MUST_LANMAN 0x10010
535 #define CIFSSEC_MUST_PLNTXT 0x20020
536 #ifdef CONFIG_CIFS_UPCALL
537 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
539 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
541 #else /* do not allow weak pw hash */
542 #ifdef CONFIG_CIFS_UPCALL
543 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
545 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
547 #endif /* WEAK_PW_HASH */
548 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
550 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
551 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
552 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
554 *****************************************************************
555 * All constants go here
556 *****************************************************************
559 #define UID_HASH (16)
562 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
563 * following to be declared.
566 /****************************************************************************
567 * Locking notes. All updates to global variables and lists should be
568 * protected by spinlocks or semaphores.
572 * GlobalMid_Lock protects:
573 * list operations on pending_mid_q and oplockQ
574 * updates to XID counters, multiplex id and SMB sequence numbers
575 * GlobalSMBSesLock protects:
576 * list operations on tcp and SMB session lists and tCon lists
577 * f_owner.lock protects certain per file struct operations
578 * mapping->page_lock protects certain per page operations
582 * sesSem operations on smb session
583 * tconSem operations on tree connection
584 * fh_sem file handle reconnection operations
586 ****************************************************************************/
588 #ifdef DECLARE_GLOBALS_HERE
589 #define GLOBAL_EXTERN
591 #define GLOBAL_EXTERN extern
595 /* the list of TCP_Server_Info structures, ie each of the sockets
596 * connecting our client to a distinct server (ip address), is
597 * chained together by global_cifs_sock_list. The list of all our SMB
598 * sessions (and from that the tree connections) can be found
599 * by iterating over global_cifs_sock_list */
600 GLOBAL_EXTERN struct list_head global_cifs_sock_list;
601 GLOBAL_EXTERN struct list_head GlobalSMBSessionList; /* BB to be removed by jl*/
602 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList; /* BB to be removed */
603 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
605 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
607 /* Outstanding dir notify requests */
608 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
609 /* DirNotify response queue */
610 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
613 * Global transaction id (XID) information
615 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
616 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
617 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
618 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
619 /* on midQ entries */
620 GLOBAL_EXTERN char Local_System_Name[15];
623 * Global counters, updated atomically
625 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
626 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
627 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
628 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
629 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
631 /* Various Debug counters */
632 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
633 #ifdef CONFIG_CIFS_STATS2
634 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
635 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
637 GLOBAL_EXTERN atomic_t smBufAllocCount;
638 GLOBAL_EXTERN atomic_t midCount;
641 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
642 to be established on existing mount if we
643 have the uid/password or Kerberos credential
644 or equivalent for current user */
645 GLOBAL_EXTERN unsigned int oplockEnabled;
646 GLOBAL_EXTERN unsigned int experimEnabled;
647 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
648 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
649 with more secure ntlmssp2 challenge/resp */
650 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
651 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
652 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
653 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
654 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
655 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/