1 // SPDX-License-Identifier: LGPL-2.1
2 /*
3 * SPNEGO upcall management for CIFS
4 *
5 * Copyright (c) 2007 Red Hat, Inc.
6 * Author(s): Jeff Layton (jlayton@redhat.com)
7 *
8 */
9
10 #include <linux/list.h>
11 #include <linux/slab.h>
12 #include <linux/string.h>
13 #include <keys/user-type.h>
14 #include <linux/key-type.h>
15 #include <linux/keyctl.h>
16 #include <linux/inet.h>
17 #include "cifsglob.h"
18 #include "cifs_spnego.h"
19 #include "cifs_debug.h"
20 #include "cifsproto.h"
21 static const struct cred *spnego_cred;
22
23 /* create a new cifs key */
24 static int
cifs_spnego_key_instantiate(struct key * key,struct key_preparsed_payload * prep)25 cifs_spnego_key_instantiate(struct key *key, struct key_preparsed_payload *prep)
26 {
27 char *payload;
28 int ret;
29
30 ret = -ENOMEM;
31 payload = kmemdup(prep->data, prep->datalen, GFP_KERNEL);
32 if (!payload)
33 goto error;
34
35 /* attach the data */
36 key->payload.data[0] = payload;
37 ret = 0;
38
39 error:
40 return ret;
41 }
42
43 static void
cifs_spnego_key_destroy(struct key * key)44 cifs_spnego_key_destroy(struct key *key)
45 {
46 kfree(key->payload.data[0]);
47 }
48
49
50 /*
51 * keytype for CIFS spnego keys
52 */
53 struct key_type cifs_spnego_key_type = {
54 .name = "cifs.spnego",
55 .instantiate = cifs_spnego_key_instantiate,
56 .destroy = cifs_spnego_key_destroy,
57 .describe = user_describe,
58 };
59
60 /* length of longest version string e.g. strlen("ver=0xFF") */
61 #define MAX_VER_STR_LEN 8
62
63 /* length of longest security mechanism name, eg in future could have
64 * strlen(";sec=ntlmsspi") */
65 #define MAX_MECH_STR_LEN 13
66
67 /* strlen of ";host=" */
68 #define HOST_KEY_LEN 6
69
70 /* strlen of ";ip4=" or ";ip6=" */
71 #define IP_KEY_LEN 5
72
73 /* strlen of ";uid=0x" */
74 #define UID_KEY_LEN 7
75
76 /* strlen of ";creduid=0x" */
77 #define CREDUID_KEY_LEN 11
78
79 /* strlen of ";user=" */
80 #define USER_KEY_LEN 6
81
82 /* strlen of ";pid=0x" */
83 #define PID_KEY_LEN 7
84
85 /* get a key struct with a SPNEGO security blob, suitable for session setup */
86 struct key *
cifs_get_spnego_key(struct cifs_ses * sesInfo,struct TCP_Server_Info * server)87 cifs_get_spnego_key(struct cifs_ses *sesInfo,
88 struct TCP_Server_Info *server)
89 {
90 struct sockaddr_in *sa = (struct sockaddr_in *) &server->dstaddr;
91 struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *) &server->dstaddr;
92 char *description, *dp;
93 size_t desc_len;
94 struct key *spnego_key;
95 const char *hostname = server->hostname;
96 const struct cred *saved_cred;
97
98 /* length of fields (with semicolons): ver=0xyz ip4=ipaddress
99 host=hostname sec=mechanism uid=0xFF user=username */
100 desc_len = MAX_VER_STR_LEN +
101 HOST_KEY_LEN + strlen(hostname) +
102 IP_KEY_LEN + INET6_ADDRSTRLEN +
103 MAX_MECH_STR_LEN +
104 UID_KEY_LEN + (sizeof(uid_t) * 2) +
105 CREDUID_KEY_LEN + (sizeof(uid_t) * 2) +
106 PID_KEY_LEN + (sizeof(pid_t) * 2) + 1;
107
108 if (sesInfo->user_name)
109 desc_len += USER_KEY_LEN + strlen(sesInfo->user_name);
110
111 spnego_key = ERR_PTR(-ENOMEM);
112 description = kzalloc(desc_len, GFP_KERNEL);
113 if (description == NULL)
114 goto out;
115
116 dp = description;
117 /* start with version and hostname portion of UNC string */
118 spnego_key = ERR_PTR(-EINVAL);
119 sprintf(dp, "ver=0x%x;host=%s;", CIFS_SPNEGO_UPCALL_VERSION,
120 hostname);
121 dp = description + strlen(description);
122
123 /* add the server address */
124 if (server->dstaddr.ss_family == AF_INET)
125 sprintf(dp, "ip4=%pI4", &sa->sin_addr);
126 else if (server->dstaddr.ss_family == AF_INET6)
127 sprintf(dp, "ip6=%pI6", &sa6->sin6_addr);
128 else
129 goto out;
130
131 dp = description + strlen(description);
132
133 /* for now, only sec=krb5 and sec=mskrb5 and iakerb are valid */
134 if (server->sec_kerberos)
135 sprintf(dp, ";sec=krb5");
136 else if (server->sec_mskerberos)
137 sprintf(dp, ";sec=mskrb5");
138 else if (server->sec_iakerb)
139 sprintf(dp, ";sec=iakerb");
140 else {
141 cifs_dbg(VFS, "unknown or missing server auth type, use krb5\n");
142 sprintf(dp, ";sec=krb5");
143 }
144
145 dp = description + strlen(description);
146 sprintf(dp, ";uid=0x%x",
147 from_kuid_munged(&init_user_ns, sesInfo->linux_uid));
148
149 dp = description + strlen(description);
150 sprintf(dp, ";creduid=0x%x",
151 from_kuid_munged(&init_user_ns, sesInfo->cred_uid));
152
153 if (sesInfo->user_name) {
154 dp = description + strlen(description);
155 sprintf(dp, ";user=%s", sesInfo->user_name);
156 }
157
158 dp = description + strlen(description);
159 sprintf(dp, ";pid=0x%x", current->pid);
160
161 cifs_dbg(FYI, "key description = %s\n", description);
162 saved_cred = override_creds(spnego_cred);
163 spnego_key = request_key(&cifs_spnego_key_type, description, "");
164 revert_creds(saved_cred);
165
166 #ifdef CONFIG_CIFS_DEBUG2
167 if (cifsFYI && !IS_ERR(spnego_key)) {
168 struct cifs_spnego_msg *msg = spnego_key->payload.data[0];
169 cifs_dump_mem("SPNEGO reply blob:", msg->data, min(1024U,
170 msg->secblob_len + msg->sesskey_len));
171 }
172 #endif /* CONFIG_CIFS_DEBUG2 */
173
174 out:
175 kfree(description);
176 return spnego_key;
177 }
178
179 int
init_cifs_spnego(void)180 init_cifs_spnego(void)
181 {
182 struct cred *cred;
183 struct key *keyring;
184 int ret;
185
186 cifs_dbg(FYI, "Registering the %s key type\n",
187 cifs_spnego_key_type.name);
188
189 /*
190 * Create an override credential set with special thread keyring for
191 * spnego upcalls.
192 */
193
194 cred = prepare_kernel_cred(&init_task);
195 if (!cred)
196 return -ENOMEM;
197
198 keyring = keyring_alloc(".cifs_spnego",
199 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
200 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
201 KEY_USR_VIEW | KEY_USR_READ,
202 KEY_ALLOC_NOT_IN_QUOTA, NULL, NULL);
203 if (IS_ERR(keyring)) {
204 ret = PTR_ERR(keyring);
205 goto failed_put_cred;
206 }
207
208 ret = register_key_type(&cifs_spnego_key_type);
209 if (ret < 0)
210 goto failed_put_key;
211
212 /*
213 * instruct request_key() to use this special keyring as a cache for
214 * the results it looks up
215 */
216 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
217 cred->thread_keyring = keyring;
218 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
219 spnego_cred = cred;
220
221 cifs_dbg(FYI, "cifs spnego keyring: %d\n", key_serial(keyring));
222 return 0;
223
224 failed_put_key:
225 key_put(keyring);
226 failed_put_cred:
227 put_cred(cred);
228 return ret;
229 }
230
231 void
exit_cifs_spnego(void)232 exit_cifs_spnego(void)
233 {
234 key_revoke(spnego_cred->thread_keyring);
235 unregister_key_type(&cifs_spnego_key_type);
236 put_cred(spnego_cred);
237 cifs_dbg(FYI, "Unregistered %s key type\n", cifs_spnego_key_type.name);
238 }
239