2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-2002
5 Copyright (C) Simo Sorce 2001
6 Copyright (C) Andrew Bartlett 2002
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program 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 the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 /* -------------------------------------------------------------------------- **
28 * magic_char - This is the magic char used for mangling. It's
29 * global. There is a call to lp_magicchar() in server.c
30 * that is used to override the initial value.
32 * MANGLE_BASE - This is the number of characters we use for name mangling.
34 * basechars - The set characters used for name mangling. This
35 * is static (scope is this file only).
37 * mangle() - Macro used to select a character from basechars (i.e.,
38 * mangle(n) will return the nth digit, modulo MANGLE_BASE).
40 * chartest - array 0..255. The index range is the set of all possible
41 * values of a byte. For each byte value, the content is a
42 * two nibble pair. See BASECHAR_MASK below.
44 * ct_initialized - False until the chartest array has been initialized via
45 * a call to init_chartest().
47 * BASECHAR_MASK - Masks the upper nibble of a one-byte value.
49 * isbasecahr() - Given a character, check the chartest array to see
50 * if that character is in the basechars set. This is
51 * faster than using strchr_m().
55 char magic_char = '~';
57 static char basechars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
58 #define MANGLE_BASE (sizeof(basechars)/sizeof(char)-1)
60 static unsigned char chartest[256] = { 0 };
61 static BOOL ct_initialized = False;
63 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
64 #define BASECHAR_MASK 0xf0
65 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
67 static TDB_CONTEXT *tdb_mangled_cache;
69 /* -------------------------------------------------------------------- */
71 static NTSTATUS has_valid_83_chars(const smb_ucs2_t *s, BOOL allow_wildcards)
74 return NT_STATUS_INVALID_PARAMETER;
77 if (!allow_wildcards && ms_has_wild_w(s)) {
78 return NT_STATUS_UNSUCCESSFUL;
82 if(!isvalid83_w(*s)) {
83 return NT_STATUS_UNSUCCESSFUL;
91 static NTSTATUS has_illegal_chars(const smb_ucs2_t *s, BOOL allow_wildcards)
93 if (!allow_wildcards && ms_has_wild_w(s)) {
94 return NT_STATUS_UNSUCCESSFUL;
99 /* Control characters. */
100 return NT_STATUS_UNSUCCESSFUL;
103 case UCS2_CHAR('\\'):
107 return NT_STATUS_UNSUCCESSFUL;
115 /* return False if something fail and
116 * return 2 alloced unicode strings that contain prefix and extension
119 static NTSTATUS mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix,
120 smb_ucs2_t **extension, BOOL allow_wildcards)
126 *prefix = strdup_w(ucs2_string);
128 return NT_STATUS_NO_MEMORY;
130 if ((p = strrchr_w(*prefix, UCS2_CHAR('.')))) {
131 ext_len = strlen_w(p+1);
132 if ((ext_len > 0) && (ext_len < 4) && (p != *prefix) &&
133 (NT_STATUS_IS_OK(has_valid_83_chars(p+1,allow_wildcards)))) /* check extension */ {
135 *extension = strdup_w(p+1);
138 return NT_STATUS_NO_MEMORY;
145 /* ************************************************************************** **
146 * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
147 * or contains illegal characters.
149 * Input: fname - String containing the name to be tested.
151 * Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
153 * Notes: This is a static function called by is_8_3(), below.
155 * ************************************************************************** **
158 static NTSTATUS is_valid_name(const smb_ucs2_t *fname, BOOL allow_wildcards, BOOL only_8_3)
161 size_t num_ucs2_chars;
162 NTSTATUS ret = NT_STATUS_OK;
164 if (!fname || !*fname)
165 return NT_STATUS_INVALID_PARAMETER;
167 /* . and .. are valid names. */
168 if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
172 ret = has_valid_83_chars(fname, allow_wildcards);
173 if (!NT_STATUS_IS_OK(ret))
177 ret = has_illegal_chars(fname, allow_wildcards);
178 if (!NT_STATUS_IS_OK(ret))
181 /* Name can't end in '.' or ' ' */
182 num_ucs2_chars = strlen_w(fname);
183 if (fname[num_ucs2_chars-1] == UCS2_CHAR('.') || fname[num_ucs2_chars-1] == UCS2_CHAR(' ')) {
184 return NT_STATUS_UNSUCCESSFUL;
187 str = strdup_w(fname);
189 /* Truncate copy after the first dot. */
190 p = strchr_w(str, UCS2_CHAR('.'));
201 if(strcmp_wa(p, "UX") == 0)
202 ret = NT_STATUS_UNSUCCESSFUL;
205 if((strcmp_wa(p, "LOCK$") == 0)
206 || (strcmp_wa(p, "ON") == 0)
207 || (strcmp_wa(p, "OM1") == 0)
208 || (strcmp_wa(p, "OM2") == 0)
209 || (strcmp_wa(p, "OM3") == 0)
210 || (strcmp_wa(p, "OM4") == 0)
212 ret = NT_STATUS_UNSUCCESSFUL;
215 if((strcmp_wa(p, "PT1") == 0)
216 || (strcmp_wa(p, "PT2") == 0)
217 || (strcmp_wa(p, "PT3") == 0)
219 ret = NT_STATUS_UNSUCCESSFUL;
222 if(strcmp_wa(p, "UL") == 0)
223 ret = NT_STATUS_UNSUCCESSFUL;
226 if(strcmp_wa(p, "RN") == 0)
227 ret = NT_STATUS_UNSUCCESSFUL;
237 static NTSTATUS is_8_3_w(const smb_ucs2_t *fname, BOOL allow_wildcards)
239 smb_ucs2_t *pref = 0, *ext = 0;
241 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
243 if (!fname || !*fname)
244 return NT_STATUS_INVALID_PARAMETER;
246 if (strlen_w(fname) > 12)
247 return NT_STATUS_UNSUCCESSFUL;
249 if (strcmp_wa(fname, ".") == 0 || strcmp_wa(fname, "..") == 0)
252 /* Name cannot start with '.' */
253 if (*fname == UCS2_CHAR('.'))
254 return NT_STATUS_UNSUCCESSFUL;
256 if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
259 if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
261 plen = strlen_w(pref);
263 if (strchr_wa(pref, '.'))
265 if (plen < 1 || plen > 8)
267 if (ext && (strlen_w(ext) > 3))
278 static BOOL is_8_3(const char *fname, BOOL check_case, BOOL allow_wildcards, int snum)
281 smb_ucs2_t *ucs2name;
282 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
285 magic_char = lp_magicchar(snum);
287 if (!fname || !*fname)
289 if ((f = strrchr(fname, '/')) == NULL)
297 size = push_ucs2_allocate(&ucs2name, f);
298 if (size == (size_t)-1) {
299 DEBUG(0,("is_8_3: internal error push_ucs2_allocate() failed!\n"));
303 ret = is_8_3_w(ucs2name, allow_wildcards);
308 if (!NT_STATUS_IS_OK(ret)) {
317 /* -------------------------------------------------------------------------- **
321 /* ************************************************************************** **
322 * Initialize the static character test array.
328 * Notes: This function changes (loads) the contents of the <chartest>
329 * array. The scope of <chartest> is this file.
331 * ************************************************************************** **
333 static void init_chartest( void )
335 const unsigned char *s;
337 memset( (char *)chartest, '\0', 256 );
339 for( s = (const unsigned char *)basechars; *s; s++ ) {
340 chartest[*s] |= BASECHAR_MASK;
343 ct_initialized = True;
346 /* ************************************************************************** **
347 * Return True if the name *could be* a mangled name.
349 * Input: s - A path name - in UNIX pathname format.
351 * Output: True if the name matches the pattern described below in the
354 * Notes: The input name is *not* tested for 8.3 compliance. This must be
355 * done separately. This function returns true if the name contains
356 * a magic character followed by excactly two characters from the
357 * basechars list (above), which in turn are followed either by the
358 * nul (end of string) byte or a dot (extension) or by a '/' (end of
361 * ************************************************************************** **
363 static BOOL is_mangled(const char *s, int snum)
367 magic_char = lp_magicchar(snum);
369 if( !ct_initialized )
372 magic = strchr_m( s, magic_char );
373 while( magic && magic[1] && magic[2] ) { /* 3 chars, 1st is magic. */
374 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3])) /* Ends with '.' or nul or '/' ? */
375 && isbasechar( toupper(magic[1]) ) /* is 2nd char basechar? */
376 && isbasechar( toupper(magic[2]) ) ) /* is 3rd char basechar? */
377 return( True ); /* If all above, then true, */
378 magic = strchr_m( magic+1, magic_char ); /* else seek next magic. */
383 /***************************************************************************
384 Initializes or clears the mangled cache.
385 ***************************************************************************/
387 static void mangle_reset( void )
389 /* We could close and re-open the tdb here... should we ? The old code did
390 the equivalent... JRA. */
393 /***************************************************************************
394 Add a mangled name into the cache.
395 If the extension of the raw name maps directly to the
396 extension of the mangled name, then we'll store both names
397 *without* extensions. That way, we can provide consistent
398 reverse mangling for all names that match. The test here is
399 a bit more careful than the one done in earlier versions of
402 - the extension must exist on the raw name,
403 - it must be all lower case
404 - it must match the mangled extension (to prove that no
407 **************************************************************************/
409 static void cache_mangled_name( const char mangled_name[13], char *raw_name )
412 char mangled_name_key[13];
416 /* If the cache isn't initialized, give up. */
417 if( !tdb_mangled_cache )
420 /* Init the string lengths. */
421 safe_strcpy(mangled_name_key, mangled_name, sizeof(mangled_name_key)-1);
423 /* See if the extensions are unmangled. If so, store the entry
424 * without the extension, thus creating a "group" reverse map.
426 s1 = strrchr( mangled_name_key, '.' );
427 if( s1 && (s2 = strrchr( raw_name, '.' )) ) {
429 while( s1[i] && (tolower( s1[i] ) == s2[i]) )
431 if( !s1[i] && !s2[i] ) {
432 /* Truncate at the '.' */
438 /* Allocate a new cache entry. If the allocation fails, just return. */
439 data_val.dptr = raw_name;
440 data_val.dsize = strlen(raw_name)+1;
441 if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
442 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
444 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
448 /* ************************************************************************** **
449 * Check for a name on the mangled name stack
451 * Input: s - Input *and* output string buffer.
452 * maxlen - space in i/o string buffer.
453 * Output: True if the name was found in the cache, else False.
455 * Notes: If a reverse map is found, the function will overwrite the string
456 * space indicated by the input pointer <s>. This is frightening.
457 * It should be rewritten to return NULL if the long name was not
458 * found, and a pointer to the long name if it was found.
460 * ************************************************************************** **
463 static BOOL check_cache( char *s, size_t maxlen, int snum )
466 char *ext_start = NULL;
467 char *saved_ext = NULL;
469 magic_char = lp_magicchar(snum);
471 /* If the cache isn't initialized, give up. */
472 if( !tdb_mangled_cache )
475 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
477 /* If we didn't find the name *with* the extension, try without. */
478 if(data_val.dptr == NULL || data_val.dsize == 0) {
479 ext_start = strrchr( s, '.' );
481 if((saved_ext = SMB_STRDUP(ext_start)) == NULL)
485 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
487 * At this point s is the name without the
488 * extension. We re-add the extension if saved_ext
489 * is not null, before freeing saved_ext.
494 /* Okay, if we haven't found it we're done. */
495 if(data_val.dptr == NULL || data_val.dsize == 0) {
497 /* Replace the saved_ext as it was truncated. */
498 (void)safe_strcat( s, saved_ext, maxlen );
499 SAFE_FREE(saved_ext);
504 /* If we *did* find it, we need to copy it into the string buffer. */
505 (void)safe_strcpy( s, data_val.dptr, maxlen );
507 /* Replace the saved_ext as it was truncated. */
508 (void)safe_strcat( s, saved_ext, maxlen );
509 SAFE_FREE(saved_ext);
511 SAFE_FREE(data_val.dptr);
515 /*****************************************************************************
516 * do the actual mangling to 8.3 format
517 * the buffer must be able to hold 13 characters (including the null)
518 *****************************************************************************
520 static void to_8_3(char *s, int default_case)
533 if( p && (strlen(p+1) < (size_t)4) ) {
534 BOOL all_normal = ( strisnormal(p+1, default_case) ); /* XXXXXXXXX */
536 if( all_normal && p[1] != 0 ) {
538 csum = str_checksum( s );
541 csum = str_checksum(s);
543 csum = str_checksum(s);
549 safe_strcpy( extension, "___", 3 );
552 while( *p && extlen < 3 ) {
554 extension[extlen++] = p[0];
558 extension[extlen] = 0;
564 while( *p && baselen < 5 ) {
565 if (isbasechar(*p)) {
566 base[baselen++] = p[0];
572 csum = csum % (MANGLE_BASE*MANGLE_BASE);
574 (void)slprintf(s, 12, "%s%c%c%c",
575 base, magic_char, mangle( csum/MANGLE_BASE ), mangle( csum ) );
578 (void)pstrcat( s, "." );
579 (void)pstrcat( s, extension );
583 /*****************************************************************************
584 * Convert a filename to DOS format. Return True if successful.
586 * Input: OutName - Source *and* destination buffer.
588 * NOTE that OutName must point to a memory space that
589 * is at least 13 bytes in size!
591 * need83 - If False, name mangling will be skipped unless the
592 * name contains illegal characters. Mapping will still
593 * be done, if appropriate. This is probably used to
594 * signal that a client does not require name mangling,
595 * thus skipping the name mangling even on shares which
596 * have name-mangling turned on.
597 * cache83 - If False, the mangled name cache will not be updated.
598 * This is usually used to prevent that we overwrite
599 * a conflicting cache entry prematurely, i.e. before
600 * we know whether the client is really interested in the
601 * current name. (See PR#13758). UKD.
603 * Output: Returns False only if the name wanted mangling but the share does
604 * not have name mangling turned on.
606 * ****************************************************************************
609 static void name_map(char *OutName, BOOL need83, BOOL cache83, int default_case, int snum)
611 smb_ucs2_t *OutName_ucs2;
612 magic_char = lp_magicchar(snum);
614 DEBUG(5,("name_map( %s, need83 = %s, cache83 = %s)\n", OutName,
615 need83 ? "True" : "False", cache83 ? "True" : "False"));
617 if (push_ucs2_allocate(&OutName_ucs2, OutName) == (size_t)-1) {
618 DEBUG(0, ("push_ucs2_allocate failed!\n"));
622 if( !need83 && !NT_STATUS_IS_OK(is_valid_name(OutName_ucs2, False, False)))
625 /* check if it's already in 8.3 format */
626 if (need83 && !NT_STATUS_IS_OK(is_8_3_w(OutName_ucs2, False))) {
629 /* mangle it into 8.3 */
631 tmp = SMB_STRDUP(OutName);
633 to_8_3(OutName, default_case);
636 cache_mangled_name(OutName, tmp);
641 DEBUG(5,("name_map() ==> [%s]\n", OutName));
642 SAFE_FREE(OutName_ucs2);
646 the following provides the abstraction layer to make it easier
647 to drop in an alternative mangling implementation
649 static struct mangle_fns mangle_fns = {
657 /* return the methods for this mangling implementation */
658 struct mangle_fns *mangle_hash_init(void)
662 /* Create the in-memory tdb using our custom hash function. */
663 tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
664 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);