xref: /linux/fs/smb/server/mgmt/user_session.h (revision c3d85c669d09007aeb9eb9f3d28d8c863401f83f)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
4  */
5 
6 #ifndef __USER_SESSION_MANAGEMENT_H__
7 #define __USER_SESSION_MANAGEMENT_H__
8 
9 #include <linux/hashtable.h>
10 #include <linux/xarray.h>
11 
12 #include "../smb_common.h"
13 #include "../ntlmssp.h"
14 
15 #define CIFDS_SESSION_FLAG_SMB2		BIT(1)
16 
17 #define PREAUTH_HASHVALUE_SIZE		64
18 
19 struct ksmbd_file_table;
20 
21 struct channel {
22 	char			sess_key[CIFS_KEY_SIZE];
23 	__u8			smb3signingkey[SMB3_SIGN_KEY_SIZE];
24 	struct ksmbd_conn	*conn;
25 };
26 
27 struct preauth_session {
28 	__u8			Preauth_HashValue[PREAUTH_HASHVALUE_SIZE];
29 	u64			id;
30 	struct list_head	preauth_entry;
31 };
32 
33 struct ksmbd_session {
34 	u64				id;
35 
36 	__u16				dialect;
37 	char				ClientGUID[SMB2_CLIENT_GUID_SIZE];
38 
39 	struct ksmbd_user		*user;
40 	unsigned int			sequence_number;
41 	unsigned int			flags;
42 
43 	bool				sign;
44 	bool				enc;
45 	bool				tearing_down;
46 
47 	int				state;
48 	__u8				*Preauth_HashValue;
49 
50 	char				sess_key[CIFS_KEY_SIZE];
51 	u64				kerberos_expiry;
52 
53 	struct hlist_node		hlist;
54 	struct rw_semaphore		chann_lock;
55 	struct xarray			ksmbd_chann_list;
56 	struct xarray			tree_conns;
57 	struct ida			tree_conn_ida;
58 	struct xarray			rpc_handle_list;
59 
60 	__u8				smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
61 	__u8				smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
62 	__u8				smb3signingkey[SMB3_SIGN_KEY_SIZE];
63 
64 	struct ksmbd_file_table		file_table;
65 	unsigned long			last_active;
66 	struct rw_semaphore		tree_conns_lock;
67 
68 #ifdef CONFIG_PROC_FS
69 	struct proc_dir_entry		*proc_entry;
70 #endif
71 	atomic_t			refcnt;
72 	struct rw_semaphore		rpc_lock;
73 };
74 
75 #define KSMBD_MAX_CHANNELS	32
76 
test_session_flag(struct ksmbd_session * sess,int bit)77 static inline int test_session_flag(struct ksmbd_session *sess, int bit)
78 {
79 	return sess->flags & bit;
80 }
81 
set_session_flag(struct ksmbd_session * sess,int bit)82 static inline void set_session_flag(struct ksmbd_session *sess, int bit)
83 {
84 	sess->flags |= bit;
85 }
86 
clear_session_flag(struct ksmbd_session * sess,int bit)87 static inline void clear_session_flag(struct ksmbd_session *sess, int bit)
88 {
89 	sess->flags &= ~bit;
90 }
91 
92 struct ksmbd_session *ksmbd_smb2_session_create(void);
93 
94 void ksmbd_session_destroy(struct ksmbd_session *sess);
95 
96 struct ksmbd_session *ksmbd_session_lookup_slowpath(unsigned long long id);
97 struct ksmbd_session *ksmbd_session_lookup(struct ksmbd_conn *conn,
98 					   unsigned long long id);
99 bool is_ksmbd_session_in_connection(struct ksmbd_conn *conn,
100 				     unsigned long long id);
101 int ksmbd_session_register(struct ksmbd_conn *conn,
102 			   struct ksmbd_session *sess);
103 void ksmbd_session_unregister(struct ksmbd_conn *conn,
104 			      struct ksmbd_session *sess);
105 void ksmbd_conn_sessions_cleanup(struct ksmbd_conn *conn);
106 bool ksmbd_conn_has_valid_or_expired_session(struct ksmbd_conn *conn);
107 void ksmbd_expire_sessions(void);
108 struct ksmbd_session *__session_lookup(unsigned long long id);
109 struct ksmbd_session *ksmbd_session_lookup_all(struct ksmbd_conn *conn,
110 					       unsigned long long id);
111 struct ksmbd_session *ksmbd_session_lookup_all_states(struct ksmbd_conn *conn,
112 						      unsigned long long id);
113 void destroy_previous_session(struct ksmbd_conn *conn,
114 			      struct ksmbd_user *user, u64 id);
115 struct preauth_session *ksmbd_preauth_session_alloc(struct ksmbd_conn *conn,
116 						    u64 sess_id);
117 void ksmbd_preauth_session_destroy(struct ksmbd_conn *conn);
118 struct preauth_session *ksmbd_preauth_session_lookup(struct ksmbd_conn *conn,
119 						     unsigned long long id);
120 
121 int ksmbd_acquire_tree_conn_id(struct ksmbd_session *sess);
122 void ksmbd_release_tree_conn_id(struct ksmbd_session *sess, int id);
123 
124 int ksmbd_session_rpc_open(struct ksmbd_session *sess, char *rpc_name);
125 void ksmbd_session_rpc_close(struct ksmbd_session *sess, int id);
126 int ksmbd_session_rpc_method(struct ksmbd_session *sess, int id);
127 void ksmbd_user_session_get(struct ksmbd_session *sess);
128 void ksmbd_user_session_put(struct ksmbd_session *sess);
129 int create_proc_sessions(void);
130 #endif /* __USER_SESSION_MANAGEMENT_H__ */
131