s3:libsmb: s/struct event_context/struct tevent_context
[Samba/gebeck_regimport.git] / source3 / libsmb / libsmb_path.c
blob1dcf2dd51672cd9c9b15f78938bf37a5b929696b
1 /*
2 Unix SMB/Netbios implementation.
3 SMB client library implementation
4 Copyright (C) Andrew Tridgell 1998
5 Copyright (C) Richard Sharpe 2000, 2002
6 Copyright (C) John Terpstra 2000
7 Copyright (C) Tom Jansen (Ninja ISD) 2002
8 Copyright (C) Derrell Lipman 2003-2008
9 Copyright (C) Jeremy Allison 2007, 2008
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "includes.h"
26 #include "libsmbclient.h"
27 #include "libsmb_internal.h"
30 /* Used by urldecode_talloc() */
31 static int
32 hex2int( unsigned int _char )
34 if ( _char >= 'A' && _char <='F')
35 return _char - 'A' + 10;
36 if ( _char >= 'a' && _char <='f')
37 return _char - 'a' + 10;
38 if ( _char >= '0' && _char <='9')
39 return _char - '0';
40 return -1;
44 * smbc_urldecode()
45 * and urldecode_talloc() (internal fn.)
47 * Convert strings of %xx to their single character equivalent. Each 'x' must
48 * be a valid hexadecimal digit, or that % sequence is left undecoded.
50 * dest may, but need not be, the same pointer as src.
52 * Returns the number of % sequences which could not be converted due to lack
53 * of two following hexadecimal digits.
55 static int
56 urldecode_talloc(TALLOC_CTX *ctx, char **pp_dest, const char *src)
58 int old_length = strlen(src);
59 int i = 0;
60 int err_count = 0;
61 size_t newlen = 1;
62 char *p, *dest;
64 if (old_length == 0) {
65 return 0;
68 *pp_dest = NULL;
69 for (i = 0; i < old_length; ) {
70 unsigned char character = src[i++];
72 if (character == '%') {
73 int a = i+1 < old_length ? hex2int(src[i]) : -1;
74 int b = i+1 < old_length ? hex2int(src[i+1]) : -1;
76 /* Replace valid sequence */
77 if (a != -1 && b != -1) {
78 /* Replace valid %xx sequence with %dd */
79 character = (a * 16) + b;
80 if (character == '\0') {
81 break; /* Stop at %00 */
83 i += 2;
84 } else {
85 err_count++;
88 newlen++;
91 dest = talloc_array(ctx, char, newlen);
92 if (!dest) {
93 return err_count;
96 err_count = 0;
97 for (p = dest, i = 0; i < old_length; ) {
98 unsigned char character = src[i++];
100 if (character == '%') {
101 int a = i+1 < old_length ? hex2int(src[i]) : -1;
102 int b = i+1 < old_length ? hex2int(src[i+1]) : -1;
104 /* Replace valid sequence */
105 if (a != -1 && b != -1) {
106 /* Replace valid %xx sequence with %dd */
107 character = (a * 16) + b;
108 if (character == '\0') {
109 break; /* Stop at %00 */
111 i += 2;
112 } else {
113 err_count++;
116 *p++ = character;
119 *p = '\0';
120 *pp_dest = dest;
121 return err_count;
125 smbc_urldecode(char *dest,
126 char *src,
127 size_t max_dest_len)
129 TALLOC_CTX *frame = talloc_stackframe();
130 char *pdest;
131 int ret = urldecode_talloc(frame, &pdest, src);
133 if (pdest) {
134 strlcpy(dest, pdest, max_dest_len);
136 TALLOC_FREE(frame);
137 return ret;
141 * smbc_urlencode()
143 * Convert any characters not specifically allowed in a URL into their %xx
144 * equivalent.
146 * Returns the remaining buffer length.
149 smbc_urlencode(char *dest,
150 char *src,
151 int max_dest_len)
153 char hex[] = "0123456789ABCDEF";
155 for (; *src != '\0' && max_dest_len >= 3; src++) {
157 if ((*src < '0' &&
158 *src != '-' &&
159 *src != '.') ||
160 (*src > '9' &&
161 *src < 'A') ||
162 (*src > 'Z' &&
163 *src < 'a' &&
164 *src != '_') ||
165 (*src > 'z')) {
166 *dest++ = '%';
167 *dest++ = hex[(*src >> 4) & 0x0f];
168 *dest++ = hex[*src & 0x0f];
169 max_dest_len -= 3;
170 } else {
171 *dest++ = *src;
172 max_dest_len--;
176 *dest++ = '\0';
177 max_dest_len--;
179 return max_dest_len;
183 * Function to parse a path and turn it into components
185 * The general format of an SMB URI is explain in Christopher Hertel's CIFS
186 * book, at http://ubiqx.org/cifs/Appendix-D.html. We accept a subset of the
187 * general format ("smb:" only; we do not look for "cifs:").
190 * We accept:
191 * smb://[[[domain;]user[:password]@]server[/share[/path[/file]]]][?options]
193 * Meaning of URLs:
195 * smb:// Show all workgroups.
197 * The method of locating the list of workgroups varies
198 * depending upon the setting of the context variable
199 * context->options.browse_max_lmb_count. This value
200 * determines the maximum number of local master browsers to
201 * query for the list of workgroups. In order to ensure that
202 * a complete list of workgroups is obtained, all master
203 * browsers must be queried, but if there are many
204 * workgroups, the time spent querying can begin to add up.
205 * For small networks (not many workgroups), it is suggested
206 * that this variable be set to 0, indicating query all local
207 * master browsers. When the network has many workgroups, a
208 * reasonable setting for this variable might be around 3.
210 * smb://name/ if name<1D> or name<1B> exists, list servers in
211 * workgroup, else, if name<20> exists, list all shares
212 * for server ...
214 * If "options" are provided, this function returns the entire option list as a
215 * string, for later parsing by the caller. Note that currently, no options
216 * are supported.
219 #define SMBC_PREFIX "smb:"
222 SMBC_parse_path(TALLOC_CTX *ctx,
223 SMBCCTX *context,
224 const char *fname,
225 char **pp_workgroup,
226 char **pp_server,
227 char **pp_share,
228 char **pp_path,
229 char **pp_user,
230 char **pp_password,
231 char **pp_options)
233 char *s;
234 const char *p;
235 char *q, *r;
236 char *workgroup = NULL;
237 int len;
239 /* Ensure these returns are at least valid pointers. */
240 *pp_server = talloc_strdup(ctx, "");
241 *pp_share = talloc_strdup(ctx, "");
242 *pp_path = talloc_strdup(ctx, "");
243 *pp_user = talloc_strdup(ctx, "");
244 *pp_password = talloc_strdup(ctx, "");
246 if (!*pp_server || !*pp_share || !*pp_path ||
247 !*pp_user || !*pp_password) {
248 return -1;
252 * Assume we wont find an authentication domain to parse, so default
253 * to the workgroup in the provided context.
255 if (pp_workgroup != NULL) {
256 *pp_workgroup =
257 talloc_strdup(ctx, smbc_getWorkgroup(context));
260 if (pp_options) {
261 *pp_options = talloc_strdup(ctx, "");
263 s = talloc_strdup(ctx, fname);
265 /* see if it has the right prefix */
266 len = strlen(SMBC_PREFIX);
267 if (strncmp(s,SMBC_PREFIX,len) || (s[len] != '/' && s[len] != 0)) {
268 return -1; /* What about no smb: ? */
271 p = s + len;
273 /* Watch the test below, we are testing to see if we should exit */
275 if (strncmp(p, "//", 2) && strncmp(p, "\\\\", 2)) {
276 DEBUG(1, ("Invalid path (does not begin with smb://"));
277 return -1;
280 p += 2; /* Skip the double slash */
282 /* See if any options were specified */
283 if ((q = strrchr(p, '?')) != NULL ) {
284 /* There are options. Null terminate here and point to them */
285 *q++ = '\0';
287 DEBUG(4, ("Found options '%s'", q));
289 /* Copy the options */
290 if (pp_options && *pp_options != NULL) {
291 TALLOC_FREE(*pp_options);
292 *pp_options = talloc_strdup(ctx, q);
296 if (*p == '\0') {
297 goto decoding;
300 if (*p == '/') {
301 int wl = strlen(smbc_getWorkgroup(context));
303 if (wl > 16) {
304 wl = 16;
307 *pp_server = talloc_strdup(ctx, smbc_getWorkgroup(context));
308 if (!*pp_server) {
309 return -1;
311 (*pp_server)[wl] = '\0';
312 return 0;
316 * ok, its for us. Now parse out the server, share etc.
318 * However, we want to parse out [[domain;]user[:password]@] if it
319 * exists ...
322 /* check that '@' occurs before '/', if '/' exists at all */
323 q = strchr_m(p, '@');
324 r = strchr_m(p, '/');
325 if (q && (!r || q < r)) {
326 char *userinfo = NULL;
327 const char *u;
329 next_token_no_ltrim_talloc(ctx, &p, &userinfo, "@");
330 if (!userinfo) {
331 return -1;
333 u = userinfo;
335 if (strchr_m(u, ';')) {
336 next_token_no_ltrim_talloc(ctx, &u, &workgroup, ";");
337 if (!workgroup) {
338 return -1;
340 if (pp_workgroup) {
341 *pp_workgroup = workgroup;
345 if (strchr_m(u, ':')) {
346 next_token_no_ltrim_talloc(ctx, &u, pp_user, ":");
347 if (!*pp_user) {
348 return -1;
350 *pp_password = talloc_strdup(ctx, u);
351 if (!*pp_password) {
352 return -1;
354 } else {
355 *pp_user = talloc_strdup(ctx, u);
356 if (!*pp_user) {
357 return -1;
362 if (!next_token_talloc(ctx, &p, pp_server, "/")) {
363 return -1;
366 if (*p == (char)0) {
367 goto decoding; /* That's it ... */
370 if (!next_token_talloc(ctx, &p, pp_share, "/")) {
371 return -1;
375 * Prepend a leading slash if there's a file path, as required by
376 * NetApp filers.
378 if (*p != '\0') {
379 *pp_path = talloc_asprintf(ctx,
380 "\\%s",
382 } else {
383 *pp_path = talloc_strdup(ctx, "");
385 if (!*pp_path) {
386 return -1;
388 string_replace(*pp_path, '/', '\\');
390 decoding:
391 (void) urldecode_talloc(ctx, pp_path, *pp_path);
392 (void) urldecode_talloc(ctx, pp_server, *pp_server);
393 (void) urldecode_talloc(ctx, pp_share, *pp_share);
394 (void) urldecode_talloc(ctx, pp_user, *pp_user);
395 (void) urldecode_talloc(ctx, pp_password, *pp_password);
397 if (!workgroup) {
398 workgroup = talloc_strdup(ctx, smbc_getWorkgroup(context));
400 if (!workgroup) {
401 return -1;
404 /* set the credentials to make DFS work */
405 smbc_set_credentials_with_fallback(context,
406 workgroup,
407 *pp_user,
408 *pp_password);
409 return 0;