2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-2002
5 Copyright (C) Simo Sorce 2001
6 Copyright (C) Andrew Bartlett 2002
7 Copyright (C) Jeremy Allison 2007
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "smbd/globals.h"
26 /* -------------------------------------------------------------------------- **
29 * magic_char - This is the magic char used for mangling. It's
30 * global. There is a call to lp_magicchar() in server.c
31 * that is used to override the initial value.
33 * MANGLE_BASE - This is the number of characters we use for name mangling.
35 * basechars - The set characters used for name mangling. This
36 * is static (scope is this file only).
38 * mangle() - Macro used to select a character from basechars (i.e.,
39 * mangle(n) will return the nth digit, modulo MANGLE_BASE).
41 * chartest - array 0..255. The index range is the set of all possible
42 * values of a byte. For each byte value, the content is a
43 * two nibble pair. See BASECHAR_MASK below.
45 * ct_initialized - False until the chartest array has been initialized via
46 * a call to init_chartest().
48 * BASECHAR_MASK - Masks the upper nibble of a one-byte value.
50 * isbasecahr() - Given a character, check the chartest array to see
51 * if that character is in the basechars set. This is
52 * faster than using strchr_m().
56 static const char basechars
[43]="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
57 #define MANGLE_BASE (sizeof(basechars)/sizeof(char)-1)
59 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
60 #define BASECHAR_MASK 0xf0
61 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
63 /* -------------------------------------------------------------------- */
65 static NTSTATUS
has_valid_83_chars(const smb_ucs2_t
*s
, bool allow_wildcards
)
68 return NT_STATUS_INVALID_PARAMETER
;
71 if (!allow_wildcards
&& ms_has_wild_w(s
)) {
72 return NT_STATUS_UNSUCCESSFUL
;
76 if(!isvalid83_w(*s
)) {
77 return NT_STATUS_UNSUCCESSFUL
;
85 static NTSTATUS
has_illegal_chars(const smb_ucs2_t
*s
, bool allow_wildcards
)
87 if (!allow_wildcards
&& ms_has_wild_w(s
)) {
88 return NT_STATUS_UNSUCCESSFUL
;
93 /* Control characters. */
94 return NT_STATUS_UNSUCCESSFUL
;
101 return NT_STATUS_UNSUCCESSFUL
;
109 /* return False if something fail and
110 * return 2 alloced unicode strings that contain prefix and extension
113 static NTSTATUS
mangle_get_prefix(const smb_ucs2_t
*ucs2_string
, smb_ucs2_t
**prefix
,
114 smb_ucs2_t
**extension
, bool allow_wildcards
)
120 *prefix
= strdup_w(ucs2_string
);
122 return NT_STATUS_NO_MEMORY
;
124 if ((p
= strrchr_w(*prefix
, UCS2_CHAR('.')))) {
125 ext_len
= strlen_w(p
+1);
126 if ((ext_len
> 0) && (ext_len
< 4) && (p
!= *prefix
) &&
127 (NT_STATUS_IS_OK(has_valid_83_chars(p
+1,allow_wildcards
)))) /* check extension */ {
129 *extension
= strdup_w(p
+1);
132 return NT_STATUS_NO_MEMORY
;
139 /* ************************************************************************** **
140 * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
141 * or contains illegal characters.
143 * Input: fname - String containing the name to be tested.
145 * Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
147 * Notes: This is a static function called by is_8_3(), below.
149 * ************************************************************************** **
152 static NTSTATUS
is_valid_name(const smb_ucs2_t
*fname
, bool allow_wildcards
, bool only_8_3
)
155 size_t num_ucs2_chars
;
156 NTSTATUS ret
= NT_STATUS_OK
;
158 if (!fname
|| !*fname
)
159 return NT_STATUS_INVALID_PARAMETER
;
161 /* . and .. are valid names. */
162 if (strcmp_wa(fname
, ".")==0 || strcmp_wa(fname
, "..")==0)
166 ret
= has_valid_83_chars(fname
, allow_wildcards
);
167 if (!NT_STATUS_IS_OK(ret
))
171 ret
= has_illegal_chars(fname
, allow_wildcards
);
172 if (!NT_STATUS_IS_OK(ret
))
175 /* Name can't end in '.' or ' ' */
176 num_ucs2_chars
= strlen_w(fname
);
177 if (fname
[num_ucs2_chars
-1] == UCS2_CHAR('.') || fname
[num_ucs2_chars
-1] == UCS2_CHAR(' ')) {
178 return NT_STATUS_UNSUCCESSFUL
;
181 str
= strdup_w(fname
);
183 /* Truncate copy after the first dot. */
184 p
= strchr_w(str
, UCS2_CHAR('.'));
195 if(strcmp_wa(p
, "UX") == 0)
196 ret
= NT_STATUS_UNSUCCESSFUL
;
199 if((strcmp_wa(p
, "LOCK$") == 0)
200 || (strcmp_wa(p
, "ON") == 0)
201 || (strcmp_wa(p
, "OM1") == 0)
202 || (strcmp_wa(p
, "OM2") == 0)
203 || (strcmp_wa(p
, "OM3") == 0)
204 || (strcmp_wa(p
, "OM4") == 0)
206 ret
= NT_STATUS_UNSUCCESSFUL
;
209 if((strcmp_wa(p
, "PT1") == 0)
210 || (strcmp_wa(p
, "PT2") == 0)
211 || (strcmp_wa(p
, "PT3") == 0)
213 ret
= NT_STATUS_UNSUCCESSFUL
;
216 if(strcmp_wa(p
, "UL") == 0)
217 ret
= NT_STATUS_UNSUCCESSFUL
;
220 if(strcmp_wa(p
, "RN") == 0)
221 ret
= NT_STATUS_UNSUCCESSFUL
;
231 static NTSTATUS
is_8_3_w(const smb_ucs2_t
*fname
, bool allow_wildcards
)
233 smb_ucs2_t
*pref
= 0, *ext
= 0;
235 NTSTATUS ret
= NT_STATUS_UNSUCCESSFUL
;
237 if (!fname
|| !*fname
)
238 return NT_STATUS_INVALID_PARAMETER
;
240 if (strlen_w(fname
) > 12)
241 return NT_STATUS_UNSUCCESSFUL
;
243 if (strcmp_wa(fname
, ".") == 0 || strcmp_wa(fname
, "..") == 0)
246 /* Name cannot start with '.' */
247 if (*fname
== UCS2_CHAR('.'))
248 return NT_STATUS_UNSUCCESSFUL
;
250 if (!NT_STATUS_IS_OK(is_valid_name(fname
, allow_wildcards
, True
)))
253 if (!NT_STATUS_IS_OK(mangle_get_prefix(fname
, &pref
, &ext
, allow_wildcards
)))
255 plen
= strlen_w(pref
);
257 if (strchr_wa(pref
, '.'))
259 if (plen
< 1 || plen
> 8)
261 if (ext
&& (strlen_w(ext
) > 3))
272 static bool is_8_3(const char *fname
, bool check_case
, bool allow_wildcards
,
273 const struct share_params
*p
)
276 smb_ucs2_t
*ucs2name
;
277 NTSTATUS ret
= NT_STATUS_UNSUCCESSFUL
;
281 magic_char
= lp_magicchar(p
);
283 if (!fname
|| !*fname
)
285 if ((f
= strrchr(fname
, '/')) == NULL
)
293 if (!push_ucs2_allocate(&ucs2name
, f
, &size
)) {
294 DEBUG(0,("is_8_3: internal error push_ucs2_allocate() failed!\n"));
298 ret
= is_8_3_w(ucs2name
, allow_wildcards
);
303 if (!NT_STATUS_IS_OK(ret
)) {
310 /* -------------------------------------------------------------------------- **
314 /* ************************************************************************** **
315 * Initialize the static character test array.
321 * Notes: This function changes (loads) the contents of the <chartest>
322 * array. The scope of <chartest> is this file.
324 * ************************************************************************** **
327 static void init_chartest( void )
329 const unsigned char *s
;
331 chartest
= SMB_MALLOC_ARRAY(unsigned char, 256);
333 SMB_ASSERT(chartest
!= NULL
);
335 for( s
= (const unsigned char *)basechars
; *s
; s
++ ) {
336 chartest
[*s
] |= BASECHAR_MASK
;
340 /* ************************************************************************** **
341 * Return True if the name *could be* a mangled name.
343 * Input: s - A path name - in UNIX pathname format.
345 * Output: True if the name matches the pattern described below in the
348 * Notes: The input name is *not* tested for 8.3 compliance. This must be
349 * done separately. This function returns true if the name contains
350 * a magic character followed by excactly two characters from the
351 * basechars list (above), which in turn are followed either by the
352 * nul (end of string) byte or a dot (extension) or by a '/' (end of
355 * ************************************************************************** **
358 static bool is_mangled(const char *s
, const struct share_params
*p
)
363 magic_char
= lp_magicchar(p
);
365 if (chartest
== NULL
) {
369 magic
= strchr_m( s
, magic_char
);
370 while( magic
&& magic
[1] && magic
[2] ) { /* 3 chars, 1st is magic. */
371 if( ('.' == magic
[3] || '/' == magic
[3] || !(magic
[3])) /* Ends with '.' or nul or '/' ? */
372 && isbasechar( toupper_ascii(magic
[1]) ) /* is 2nd char basechar? */
373 && isbasechar( toupper_ascii(magic
[2]) ) ) /* is 3rd char basechar? */
374 return( True
); /* If all above, then true, */
375 magic
= strchr_m( magic
+1, magic_char
); /* else seek next magic. */
380 /***************************************************************************
381 Initializes or clears the mangled cache.
382 ***************************************************************************/
384 static void mangle_reset( void )
386 /* We could close and re-open the tdb here... should we ? The old code did
387 the equivalent... JRA. */
390 /***************************************************************************
391 Add a mangled name into the cache.
392 If the extension of the raw name maps directly to the
393 extension of the mangled name, then we'll store both names
394 *without* extensions. That way, we can provide consistent
395 reverse mangling for all names that match. The test here is
396 a bit more careful than the one done in earlier versions of
399 - the extension must exist on the raw name,
400 - it must be all lower case
401 - it must match the mangled extension (to prove that no
404 **************************************************************************/
406 static void cache_mangled_name( const char mangled_name
[13],
407 const char *raw_name
)
410 char mangled_name_key
[13];
414 /* If the cache isn't initialized, give up. */
415 if( !tdb_mangled_cache
)
418 /* Init the string lengths. */
419 safe_strcpy(mangled_name_key
, mangled_name
, sizeof(mangled_name_key
)-1);
421 /* See if the extensions are unmangled. If so, store the entry
422 * without the extension, thus creating a "group" reverse map.
424 s1
= strrchr( mangled_name_key
, '.' );
425 if( s1
&& (s2
= strrchr( raw_name
, '.' )) ) {
427 while( s1
[i
] && (tolower_ascii( s1
[i
] ) == s2
[i
]) )
429 if( !s1
[i
] && !s2
[i
] ) {
430 /* Truncate at the '.' */
433 * DANGER WILL ROBINSON - this
434 * is changing a const string via
435 * an aliased pointer ! Remember to
436 * put it back once we've used it.
443 /* Allocate a new cache entry. If the allocation fails, just return. */
444 data_val
= string_term_tdb_data(raw_name
);
445 if (tdb_store_bystring(tdb_mangled_cache
, mangled_name_key
, data_val
, TDB_REPLACE
) != 0) {
446 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key
, raw_name
));
448 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key
, raw_name
));
450 /* Restore the change we made to the const string. */
454 /* ************************************************************************** **
455 * Check for a name on the mangled name stack
457 * Input: s - Input *and* output string buffer.
458 * maxlen - space in i/o string buffer.
459 * Output: True if the name was found in the cache, else False.
461 * Notes: If a reverse map is found, the function will overwrite the string
462 * space indicated by the input pointer <s>. This is frightening.
463 * It should be rewritten to return NULL if the long name was not
464 * found, and a pointer to the long name if it was found.
466 * ************************************************************************** **
469 static bool lookup_name_from_8_3(TALLOC_CTX
*ctx
,
471 char **out
, /* talloced on the given context. */
472 const struct share_params
*p
)
475 char *saved_ext
= NULL
;
476 char *s
= talloc_strdup(ctx
, in
);
479 magic_char
= lp_magicchar(p
);
481 /* If the cache isn't initialized, give up. */
482 if(!s
|| !tdb_mangled_cache
) {
487 data_val
= tdb_fetch_bystring(tdb_mangled_cache
, s
);
489 /* If we didn't find the name *with* the extension, try without. */
490 if(data_val
.dptr
== NULL
|| data_val
.dsize
== 0) {
491 char *ext_start
= strrchr( s
, '.' );
493 if((saved_ext
= talloc_strdup(ctx
,ext_start
)) == NULL
) {
499 data_val
= tdb_fetch_bystring(tdb_mangled_cache
, s
);
501 * At this point s is the name without the
502 * extension. We re-add the extension if saved_ext
503 * is not null, before freeing saved_ext.
508 /* Okay, if we haven't found it we're done. */
509 if(data_val
.dptr
== NULL
|| data_val
.dsize
== 0) {
510 TALLOC_FREE(saved_ext
);
515 /* If we *did* find it, we need to talloc it on the given ctx. */
517 *out
= talloc_asprintf(ctx
, "%s%s",
518 (char *)data_val
.dptr
,
521 *out
= talloc_strdup(ctx
, (char *)data_val
.dptr
);
525 TALLOC_FREE(saved_ext
);
526 SAFE_FREE(data_val
.dptr
);
528 return *out
? True
: False
;
531 /*****************************************************************************
532 Do the actual mangling to 8.3 format.
533 *****************************************************************************/
535 static bool to_8_3(char magic_char
, const char *in
, char out
[13], int default_case
)
543 char *s
= SMB_STRDUP(in
);
553 if( p
&& (strlen(p
+1) < (size_t)4) ) {
554 bool all_normal
= ( strisnormal(p
+1, default_case
) ); /* XXXXXXXXX */
556 if( all_normal
&& p
[1] != 0 ) {
558 csum
= str_checksum( s
);
561 csum
= str_checksum(s
);
563 csum
= str_checksum(s
);
569 safe_strcpy( extension
, "___", 3 );
572 while( *p
&& extlen
< 3 ) {
574 extension
[extlen
++] = p
[0];
578 extension
[extlen
] = 0;
584 while( *p
&& baselen
< 5 ) {
585 if (isbasechar(*p
)) {
586 base
[baselen
++] = p
[0];
592 csum
= csum
% (MANGLE_BASE
*MANGLE_BASE
);
594 memcpy(out
, base
, baselen
);
595 out
[baselen
] = magic_char
;
596 out
[baselen
+1] = mangle( csum
/MANGLE_BASE
);
597 out
[baselen
+2] = mangle( csum
);
600 out
[baselen
+3] = '.';
601 safe_strcpy(&out
[baselen
+4], extension
, 3);
608 static bool must_mangle(const char *name
,
609 const struct share_params
*p
)
611 smb_ucs2_t
*name_ucs2
= NULL
;
613 size_t converted_size
;
616 magic_char
= lp_magicchar(p
);
618 if (!push_ucs2_allocate(&name_ucs2
, name
, &converted_size
)) {
619 DEBUG(0, ("push_ucs2_allocate failed!\n"));
622 status
= is_valid_name(name_ucs2
, False
, False
);
623 SAFE_FREE(name_ucs2
);
624 /* We return true if we *must* mangle, so if it's
625 * a valid name (status == OK) then we must return
626 * false. Bug #6939. */
627 return !NT_STATUS_IS_OK(status
);
630 /*****************************************************************************
631 * Convert a filename to DOS format. Return True if successful.
632 * Input: in Incoming name.
636 * cache83 - If False, the mangled name cache will not be updated.
637 * This is usually used to prevent that we overwrite
638 * a conflicting cache entry prematurely, i.e. before
639 * we know whether the client is really interested in the
640 * current name. (See PR#13758). UKD.
642 * ****************************************************************************
645 static bool hash_name_to_8_3(const char *in
,
649 const struct share_params
*p
)
651 smb_ucs2_t
*in_ucs2
= NULL
;
652 size_t converted_size
;
655 magic_char
= lp_magicchar(p
);
657 DEBUG(5,("hash_name_to_8_3( %s, cache83 = %s)\n", in
,
658 cache83
? "True" : "False"));
660 if (!push_ucs2_allocate(&in_ucs2
, in
, &converted_size
)) {
661 DEBUG(0, ("push_ucs2_allocate failed!\n"));
665 /* If it's already 8.3, just copy. */
666 if (NT_STATUS_IS_OK(is_valid_name(in_ucs2
, False
, False
)) &&
667 NT_STATUS_IS_OK(is_8_3_w(in_ucs2
, False
))) {
669 safe_strcpy(out
, in
, 12);
674 if (!to_8_3(magic_char
, in
, out
, default_case
)) {
678 cache_mangled_name(out
, in
);
680 DEBUG(5,("hash_name_to_8_3(%s) ==> [%s]\n", in
, out
));
685 the following provides the abstraction layer to make it easier
686 to drop in an alternative mangling implementation
688 static const struct mangle_fns mangle_hash_fns
= {
693 lookup_name_from_8_3
,
697 /* return the methods for this mangling implementation */
698 const struct mangle_fns
*mangle_hash_init(void)
702 /* Create the in-memory tdb using our custom hash function. */
703 tdb_mangled_cache
= tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL
,
704 (O_RDWR
|O_CREAT
), 0644, NULL
, fast_string_hash
);
706 return &mangle_hash_fns
;