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 int srv_count
; /* reference counter */
127 /* 15 character server name + 0x20 16th byte indicating type = srv */
128 char server_RFC1001_name
[SERVER_NAME_LEN_WITH_NULL
];
129 char unicode_server_Name
[SERVER_NAME_LEN_WITH_NULL
* 2];
130 char *hostname
; /* hostname portion of UNC string */
131 struct socket
*ssocket
;
133 struct sockaddr_in sockAddr
;
134 struct sockaddr_in6 sockAddr6
;
136 wait_queue_head_t response_q
;
137 wait_queue_head_t request_q
; /* if more than maxmpx to srvr must block*/
138 struct list_head pending_mid_q
;
139 void *Server_NlsInfo
; /* BB - placeholder for future NLS info */
140 unsigned short server_codepage
; /* codepage for the server */
141 unsigned long ip_address
; /* IP addr for the server if known */
142 enum protocolEnum protocolType
;
145 bool svlocal
:1; /* local server or remote */
146 bool noblocksnd
; /* use blocking sendmsg */
147 bool noautotune
; /* do not autotune send buf sizes */
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 smb_ses_list
;
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 int ses_count
; /* reference counter */
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 tcon_list
;
238 struct list_head openFileList
;
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 #ifdef CONFIG_CIFS_STATS
246 atomic_t num_smbs_sent
;
249 atomic_t num_oplock_brks
;
252 atomic_t num_deletes
;
255 atomic_t num_renames
;
256 atomic_t num_t2renames
;
260 atomic_t num_hardlinks
;
261 atomic_t num_symlinks
;
263 atomic_t num_acl_get
;
264 atomic_t num_acl_set
;
265 #ifdef CONFIG_CIFS_STATS2
266 unsigned long long time_writes
;
267 unsigned long long time_reads
;
268 unsigned long long time_opens
;
269 unsigned long long time_deletes
;
270 unsigned long long time_closes
;
271 unsigned long long time_mkdirs
;
272 unsigned long long time_rmdirs
;
273 unsigned long long time_renames
;
274 unsigned long long time_t2renames
;
275 unsigned long long time_ffirst
;
276 unsigned long long time_fnext
;
277 unsigned long long time_fclose
;
278 #endif /* CONFIG_CIFS_STATS2 */
281 spinlock_t stat_lock
;
282 #endif /* CONFIG_CIFS_STATS */
283 FILE_SYSTEM_DEVICE_INFO fsDevInfo
;
284 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo
; /* ok if fs name truncated */
285 FILE_SYSTEM_UNIX_INFO fsUnixInfo
;
286 bool ipc
:1; /* set if connection to IPC$ eg for RPC/PIPES */
289 bool seal
:1; /* transport encryption for this mounted share */
290 bool unix_ext
:1; /* if false disable Linux extensions to CIFS protocol
291 for this mount even if server would support */
292 bool need_reconnect
:1; /* connection reset, tid now invalid */
293 /* BB add field for back pointer to sb struct(s)? */
297 * This info hangs off the cifsFileInfo structure, pointed to by llist.
298 * This is used to track byte stream locks on the file
300 struct cifsLockInfo
{
301 struct list_head llist
; /* pointer to next cifsLockInfo */
308 * One of these for each open instance of a file
310 struct cifs_search_info
{
311 loff_t index_of_last_entry
;
312 __u16 entries_in_buffer
;
315 char *ntwrk_buf_start
;
316 char *srch_entries_start
;
319 unsigned int resume_name_len
;
323 bool smallBuf
:1; /* so we know which buf_release function to call */
326 struct cifsFileInfo
{
327 struct list_head tlist
; /* pointer to next fid owned by tcon */
328 struct list_head flist
; /* next fid (file instance) for this inode */
329 unsigned int uid
; /* allows finding which FileInfo structure */
330 __u32 pid
; /* process id who opened file */
331 __u16 netfid
; /* file id from remote */
332 /* BB add lock scope info here if needed */ ;
333 /* lock scope id (0 if none) */
334 struct file
*pfile
; /* needed for writepage */
335 struct inode
*pInode
; /* needed for oplock break */
336 struct mutex lock_mutex
;
337 struct list_head llist
; /* list of byte range locks we have. */
338 bool closePend
:1; /* file is marked to close */
339 bool invalidHandle
:1; /* file closed via session abend */
340 bool messageMode
:1; /* for pipes: message vs byte mode */
341 atomic_t wrtPending
; /* handle in use - defer close */
342 struct semaphore fh_sem
; /* prevents reopen race after dead ses*/
343 struct cifs_search_info srch_inf
;
347 * One of these for each file inode
350 struct cifsInodeInfo
{
351 struct list_head lockList
;
352 /* BB add in lists for dirty pages i.e. write caching info for oplock */
353 struct list_head openFileList
;
355 __u32 cifsAttrs
; /* e.g. DOS archive bit, sparse, compressed, system */
356 atomic_t inUse
; /* num concurrent users (local openers cifs) of file*/
357 unsigned long time
; /* jiffies of last update/check of inode */
358 bool clientCanCacheRead
:1; /* read oplock */
359 bool clientCanCacheAll
:1; /* read and writebehind oplock */
360 bool oplockPending
:1;
361 struct inode vfs_inode
;
364 static inline struct cifsInodeInfo
*
365 CIFS_I(struct inode
*inode
)
367 return container_of(inode
, struct cifsInodeInfo
, vfs_inode
);
370 static inline struct cifs_sb_info
*
371 CIFS_SB(struct super_block
*sb
)
373 return sb
->s_fs_info
;
376 static inline char CIFS_DIR_SEP(const struct cifs_sb_info
*cifs_sb
)
378 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_POSIX_PATHS
)
384 #ifdef CONFIG_CIFS_STATS
385 #define cifs_stats_inc atomic_inc
387 static inline void cifs_stats_bytes_written(struct cifsTconInfo
*tcon
,
391 spin_lock(&tcon
->stat_lock
);
392 tcon
->bytes_written
+= bytes
;
393 spin_unlock(&tcon
->stat_lock
);
397 static inline void cifs_stats_bytes_read(struct cifsTconInfo
*tcon
,
400 spin_lock(&tcon
->stat_lock
);
401 tcon
->bytes_read
+= bytes
;
402 spin_unlock(&tcon
->stat_lock
);
406 #define cifs_stats_inc(field) do {} while (0)
407 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
408 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
412 /* one of these for every pending CIFS request to the server */
414 struct list_head qhead
; /* mids waiting on reply from this server */
415 __u16 mid
; /* multiplex id */
416 __u16 pid
; /* process id */
417 __u32 sequence_number
; /* for CIFS signing */
418 unsigned long when_alloc
; /* when mid was created */
419 #ifdef CONFIG_CIFS_STATS2
420 unsigned long when_sent
; /* time when smb send finished */
421 unsigned long when_received
; /* when demux complete (taken off wire) */
423 struct cifsSesInfo
*ses
; /* smb was sent to this server */
424 struct task_struct
*tsk
; /* task waiting for response */
425 struct smb_hdr
*resp_buf
; /* response buffer */
426 int midState
; /* wish this were enum but can not pass to wait_event */
427 __u8 command
; /* smb command code */
428 bool largeBuf
:1; /* if valid response, is pointer to large buf */
429 bool multiRsp
:1; /* multiple trans2 responses for one request */
430 bool multiEnd
:1; /* both received */
433 struct oplock_q_entry
{
434 struct list_head qhead
;
435 struct inode
*pinode
;
436 struct cifsTconInfo
*tcon
;
440 /* for pending dnotify requests */
441 struct dir_notify_req
{
442 struct list_head lhead
;
449 __u32 filter
; /* CompletionFilter (for multishot) */
454 struct dfs_info3_param
{
455 int flags
; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
463 static inline void free_dfs_info_param(struct dfs_info3_param
*param
)
466 kfree(param
->path_name
);
467 kfree(param
->node_name
);
472 static inline void free_dfs_info_array(struct dfs_info3_param
*param
,
476 if ((number_of_items
== 0) || (param
== NULL
))
478 for (i
= 0; i
< number_of_items
; i
++) {
479 kfree(param
[i
].path_name
);
480 kfree(param
[i
].node_name
);
486 #define MID_REQUEST_ALLOCATED 1
487 #define MID_REQUEST_SUBMITTED 2
488 #define MID_RESPONSE_RECEIVED 4
489 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
490 #define MID_NO_RESP_NEEDED 0x10
492 /* Types of response buffer returned from SendReceive2 */
493 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
494 #define CIFS_SMALL_BUFFER 1
495 #define CIFS_LARGE_BUFFER 2
496 #define CIFS_IOVEC 4 /* array of response buffers */
498 /* Type of Request to SendReceive2 */
499 #define CIFS_STD_OP 0 /* normal request timeout */
500 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
501 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
502 #define CIFS_BLOCKING_OP 4 /* operation can block */
503 #define CIFS_ASYNC_OP 8 /* do not wait for response */
504 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
505 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
506 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
507 #define CIFS_NO_RESP 0x040 /* no response buffer required */
509 /* Security Flags: indicate type of session setup needed */
510 #define CIFSSEC_MAY_SIGN 0x00001
511 #define CIFSSEC_MAY_NTLM 0x00002
512 #define CIFSSEC_MAY_NTLMV2 0x00004
513 #define CIFSSEC_MAY_KRB5 0x00008
514 #ifdef CONFIG_CIFS_WEAK_PW_HASH
515 #define CIFSSEC_MAY_LANMAN 0x00010
516 #define CIFSSEC_MAY_PLNTXT 0x00020
518 #define CIFSSEC_MAY_LANMAN 0
519 #define CIFSSEC_MAY_PLNTXT 0
520 #endif /* weak passwords */
521 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
523 #define CIFSSEC_MUST_SIGN 0x01001
524 /* note that only one of the following can be set so the
525 result of setting MUST flags more than once will be to
526 require use of the stronger protocol */
527 #define CIFSSEC_MUST_NTLM 0x02002
528 #define CIFSSEC_MUST_NTLMV2 0x04004
529 #define CIFSSEC_MUST_KRB5 0x08008
530 #ifdef CONFIG_CIFS_WEAK_PW_HASH
531 #define CIFSSEC_MUST_LANMAN 0x10010
532 #define CIFSSEC_MUST_PLNTXT 0x20020
533 #ifdef CONFIG_CIFS_UPCALL
534 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
536 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
538 #else /* do not allow weak pw hash */
539 #ifdef CONFIG_CIFS_UPCALL
540 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
542 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
544 #endif /* WEAK_PW_HASH */
545 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
547 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
548 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
549 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
551 *****************************************************************
552 * All constants go here
553 *****************************************************************
556 #define UID_HASH (16)
559 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
560 * following to be declared.
563 /****************************************************************************
564 * Locking notes. All updates to global variables and lists should be
565 * protected by spinlocks or semaphores.
569 * GlobalMid_Lock protects:
570 * list operations on pending_mid_q and oplockQ
571 * updates to XID counters, multiplex id and SMB sequence numbers
572 * GlobalSMBSesLock protects:
573 * list operations on tcp and SMB session lists and tCon lists
574 * f_owner.lock protects certain per file struct operations
575 * mapping->page_lock protects certain per page operations
579 * sesSem operations on smb session
580 * tconSem operations on tree connection
581 * fh_sem file handle reconnection operations
583 ****************************************************************************/
585 #ifdef DECLARE_GLOBALS_HERE
586 #define GLOBAL_EXTERN
588 #define GLOBAL_EXTERN extern
592 * the list of TCP_Server_Info structures, ie each of the sockets
593 * connecting our client to a distinct server (ip address), is
594 * chained together by cifs_tcp_ses_list. The list of all our SMB
595 * sessions (and from that the tree connections) can be found
596 * by iterating over cifs_tcp_ses_list
598 GLOBAL_EXTERN
struct list_head cifs_tcp_ses_list
;
601 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
602 * tcp session, and the list of tcon's per smb session. It also protects
603 * the reference counters for the server, smb session, and tcon. Finally,
604 * changes to the tcon->tidStatus should be done while holding this lock.
606 GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock
;
607 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock
; /* protects list inserts on 3 above */
609 GLOBAL_EXTERN
struct list_head GlobalOplock_Q
;
611 /* Outstanding dir notify requests */
612 GLOBAL_EXTERN
struct list_head GlobalDnotifyReqList
;
613 /* DirNotify response queue */
614 GLOBAL_EXTERN
struct list_head GlobalDnotifyRsp_Q
;
617 * Global transaction id (XID) information
619 GLOBAL_EXTERN
unsigned int GlobalCurrentXid
; /* protected by GlobalMid_Sem */
620 GLOBAL_EXTERN
unsigned int GlobalTotalActiveXid
; /* prot by GlobalMid_Sem */
621 GLOBAL_EXTERN
unsigned int GlobalMaxActiveXid
; /* prot by GlobalMid_Sem */
622 GLOBAL_EXTERN spinlock_t GlobalMid_Lock
; /* protects above & list operations */
623 /* on midQ entries */
624 GLOBAL_EXTERN
char Local_System_Name
[15];
627 * Global counters, updated atomically
629 GLOBAL_EXTERN atomic_t sesInfoAllocCount
;
630 GLOBAL_EXTERN atomic_t tconInfoAllocCount
;
631 GLOBAL_EXTERN atomic_t tcpSesAllocCount
;
632 GLOBAL_EXTERN atomic_t tcpSesReconnectCount
;
633 GLOBAL_EXTERN atomic_t tconInfoReconnectCount
;
635 /* Various Debug counters */
636 GLOBAL_EXTERN atomic_t bufAllocCount
; /* current number allocated */
637 #ifdef CONFIG_CIFS_STATS2
638 GLOBAL_EXTERN atomic_t totBufAllocCount
; /* total allocated over all time */
639 GLOBAL_EXTERN atomic_t totSmBufAllocCount
;
641 GLOBAL_EXTERN atomic_t smBufAllocCount
;
642 GLOBAL_EXTERN atomic_t midCount
;
645 GLOBAL_EXTERN
unsigned int multiuser_mount
; /* if enabled allows new sessions
646 to be established on existing mount if we
647 have the uid/password or Kerberos credential
648 or equivalent for current user */
649 GLOBAL_EXTERN
unsigned int oplockEnabled
;
650 GLOBAL_EXTERN
unsigned int experimEnabled
;
651 GLOBAL_EXTERN
unsigned int lookupCacheEnabled
;
652 GLOBAL_EXTERN
unsigned int extended_security
; /* if on, session setup sent
653 with more secure ntlmssp2 challenge/resp */
654 GLOBAL_EXTERN
unsigned int sign_CIFS_PDUs
; /* enable smb packet signing */
655 GLOBAL_EXTERN
unsigned int linuxExtEnabled
;/*enable Linux/Unix CIFS extensions*/
656 GLOBAL_EXTERN
unsigned int CIFSMaxBufSize
; /* max size not including hdr */
657 GLOBAL_EXTERN
unsigned int cifs_min_rcv
; /* min size of big ntwrk buf pool */
658 GLOBAL_EXTERN
unsigned int cifs_min_small
; /* min size of small buf pool */
659 GLOBAL_EXTERN
unsigned int cifs_max_pending
; /* MAX requests at once to server*/