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;
103 return NT_STATUS_UNSUCCESSFUL;
111 /* return False if something fail and
112 * return 2 alloced unicode strings that contain prefix and extension
115 static NTSTATUS mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix,
116 smb_ucs2_t **extension, BOOL allow_wildcards)
122 *prefix = strdup_w(ucs2_string);
124 return NT_STATUS_NO_MEMORY;
126 if ((p = strrchr_w(*prefix, UCS2_CHAR('.')))) {
127 ext_len = strlen_w(p+1);
128 if ((ext_len > 0) && (ext_len < 4) && (p != *prefix) &&
129 (NT_STATUS_IS_OK(has_valid_83_chars(p+1,allow_wildcards)))) /* check extension */ {
131 *extension = strdup_w(p+1);
134 return NT_STATUS_NO_MEMORY;
141 /* ************************************************************************** **
142 * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
143 * or contains illegal characters.
145 * Input: fname - String containing the name to be tested.
147 * Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
149 * Notes: This is a static function called by is_8_3(), below.
151 * ************************************************************************** **
154 static NTSTATUS is_valid_name(const smb_ucs2_t *fname, BOOL allow_wildcards, BOOL only_8_3)
157 NTSTATUS ret = NT_STATUS_OK;
159 if (!fname || !*fname)
160 return NT_STATUS_INVALID_PARAMETER;
162 /* . and .. are valid names. */
163 if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
166 /* Name cannot start with '.' */
167 if (*fname == UCS2_CHAR('.'))
168 return NT_STATUS_UNSUCCESSFUL;
171 ret = has_valid_83_chars(fname, allow_wildcards);
172 if (!NT_STATUS_IS_OK(ret))
176 ret = has_illegal_chars(fname, allow_wildcards);
177 if (!NT_STATUS_IS_OK(ret))
180 str = strdup_w(fname);
181 p = strchr_w(str, UCS2_CHAR('.'));
182 if (p && p[1] == UCS2_CHAR(0)) {
183 /* Name cannot end in '.' */
185 return NT_STATUS_UNSUCCESSFUL;
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 if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
249 if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
251 plen = strlen_w(pref);
253 if (strchr_wa(pref, '.'))
255 if (plen < 1 || plen > 8)
257 if (ext && (strlen_w(ext) > 3))
268 static BOOL is_8_3(const char *fname, BOOL check_case, BOOL allow_wildcards, int snum)
271 smb_ucs2_t *ucs2name;
272 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
275 magic_char = lp_magicchar(snum);
277 if (!fname || !*fname)
279 if ((f = strrchr(fname, '/')) == NULL)
287 size = push_ucs2_allocate(&ucs2name, f);
288 if (size == (size_t)-1) {
289 DEBUG(0,("is_8_3: internal error push_ucs2_allocate() failed!\n"));
293 ret = is_8_3_w(ucs2name, allow_wildcards);
298 if (!NT_STATUS_IS_OK(ret)) {
307 /* -------------------------------------------------------------------------- **
311 /* ************************************************************************** **
312 * Initialize the static character test array.
318 * Notes: This function changes (loads) the contents of the <chartest>
319 * array. The scope of <chartest> is this file.
321 * ************************************************************************** **
323 static void init_chartest( void )
325 const unsigned char *s;
327 memset( (char *)chartest, '\0', 256 );
329 for( s = (const unsigned char *)basechars; *s; s++ ) {
330 chartest[*s] |= BASECHAR_MASK;
333 ct_initialized = True;
336 /* ************************************************************************** **
337 * Return True if the name *could be* a mangled name.
339 * Input: s - A path name - in UNIX pathname format.
341 * Output: True if the name matches the pattern described below in the
344 * Notes: The input name is *not* tested for 8.3 compliance. This must be
345 * done separately. This function returns true if the name contains
346 * a magic character followed by excactly two characters from the
347 * basechars list (above), which in turn are followed either by the
348 * nul (end of string) byte or a dot (extension) or by a '/' (end of
351 * ************************************************************************** **
353 static BOOL is_mangled(const char *s, int snum)
357 magic_char = lp_magicchar(snum);
359 if( !ct_initialized )
362 magic = strchr_m( s, magic_char );
363 while( magic && magic[1] && magic[2] ) { /* 3 chars, 1st is magic. */
364 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3])) /* Ends with '.' or nul or '/' ? */
365 && isbasechar( toupper(magic[1]) ) /* is 2nd char basechar? */
366 && isbasechar( toupper(magic[2]) ) ) /* is 3rd char basechar? */
367 return( True ); /* If all above, then true, */
368 magic = strchr_m( magic+1, magic_char ); /* else seek next magic. */
373 /***************************************************************************
374 Initializes or clears the mangled cache.
375 ***************************************************************************/
377 static void mangle_reset( void )
379 /* We could close and re-open the tdb here... should we ? The old code did
380 the equivalent... JRA. */
383 /***************************************************************************
384 Add a mangled name into the cache.
385 If the extension of the raw name maps directly to the
386 extension of the mangled name, then we'll store both names
387 *without* extensions. That way, we can provide consistent
388 reverse mangling for all names that match. The test here is
389 a bit more careful than the one done in earlier versions of
392 - the extension must exist on the raw name,
393 - it must be all lower case
394 - it must match the mangled extension (to prove that no
397 **************************************************************************/
399 static void cache_mangled_name( const char mangled_name[13], char *raw_name )
402 char mangled_name_key[13];
406 /* If the cache isn't initialized, give up. */
407 if( !tdb_mangled_cache )
410 /* Init the string lengths. */
411 safe_strcpy(mangled_name_key, mangled_name, sizeof(mangled_name_key)-1);
413 /* See if the extensions are unmangled. If so, store the entry
414 * without the extension, thus creating a "group" reverse map.
416 s1 = strrchr( mangled_name_key, '.' );
417 if( s1 && (s2 = strrchr( raw_name, '.' )) ) {
419 while( s1[i] && (tolower( s1[i] ) == s2[i]) )
421 if( !s1[i] && !s2[i] ) {
422 /* Truncate at the '.' */
428 /* Allocate a new cache entry. If the allocation fails, just return. */
429 data_val.dptr = raw_name;
430 data_val.dsize = strlen(raw_name)+1;
431 if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
432 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
434 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
438 /* ************************************************************************** **
439 * Check for a name on the mangled name stack
441 * Input: s - Input *and* output string buffer.
442 * maxlen - space in i/o string buffer.
443 * Output: True if the name was found in the cache, else False.
445 * Notes: If a reverse map is found, the function will overwrite the string
446 * space indicated by the input pointer <s>. This is frightening.
447 * It should be rewritten to return NULL if the long name was not
448 * found, and a pointer to the long name if it was found.
450 * ************************************************************************** **
453 static BOOL check_cache( char *s, size_t maxlen, int snum )
456 char *ext_start = NULL;
457 char *saved_ext = NULL;
459 magic_char = lp_magicchar(snum);
461 /* If the cache isn't initialized, give up. */
462 if( !tdb_mangled_cache )
465 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
467 /* If we didn't find the name *with* the extension, try without. */
468 if(data_val.dptr == NULL || data_val.dsize == 0) {
469 ext_start = strrchr( s, '.' );
471 if((saved_ext = SMB_STRDUP(ext_start)) == NULL)
475 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
477 * At this point s is the name without the
478 * extension. We re-add the extension if saved_ext
479 * is not null, before freeing saved_ext.
484 /* Okay, if we haven't found it we're done. */
485 if(data_val.dptr == NULL || data_val.dsize == 0) {
487 /* Replace the saved_ext as it was truncated. */
488 (void)safe_strcat( s, saved_ext, maxlen );
489 SAFE_FREE(saved_ext);
494 /* If we *did* find it, we need to copy it into the string buffer. */
495 (void)safe_strcpy( s, data_val.dptr, maxlen );
497 /* Replace the saved_ext as it was truncated. */
498 (void)safe_strcat( s, saved_ext, maxlen );
499 SAFE_FREE(saved_ext);
501 SAFE_FREE(data_val.dptr);
505 /*****************************************************************************
506 * do the actual mangling to 8.3 format
507 * the buffer must be able to hold 13 characters (including the null)
508 *****************************************************************************
510 static void to_8_3(char *s, int default_case)
523 if( p && (strlen(p+1) < (size_t)4) ) {
524 BOOL all_normal = ( strisnormal(p+1, default_case) ); /* XXXXXXXXX */
526 if( all_normal && p[1] != 0 ) {
528 csum = str_checksum( s );
531 csum = str_checksum(s);
533 csum = str_checksum(s);
539 safe_strcpy( extension, "___", 3 );
542 while( *p && extlen < 3 ) {
544 extension[extlen++] = p[0];
548 extension[extlen] = 0;
554 while( *p && baselen < 5 ) {
555 if (isbasechar(*p)) {
556 base[baselen++] = p[0];
562 csum = csum % (MANGLE_BASE*MANGLE_BASE);
564 (void)slprintf(s, 12, "%s%c%c%c",
565 base, magic_char, mangle( csum/MANGLE_BASE ), mangle( csum ) );
568 (void)pstrcat( s, "." );
569 (void)pstrcat( s, extension );
573 /*****************************************************************************
574 * Convert a filename to DOS format. Return True if successful.
576 * Input: OutName - Source *and* destination buffer.
578 * NOTE that OutName must point to a memory space that
579 * is at least 13 bytes in size!
581 * need83 - If False, name mangling will be skipped unless the
582 * name contains illegal characters. Mapping will still
583 * be done, if appropriate. This is probably used to
584 * signal that a client does not require name mangling,
585 * thus skipping the name mangling even on shares which
586 * have name-mangling turned on.
587 * cache83 - If False, the mangled name cache will not be updated.
588 * This is usually used to prevent that we overwrite
589 * a conflicting cache entry prematurely, i.e. before
590 * we know whether the client is really interested in the
591 * current name. (See PR#13758). UKD.
593 * Output: Returns False only if the name wanted mangling but the share does
594 * not have name mangling turned on.
596 * ****************************************************************************
599 static void name_map(char *OutName, BOOL need83, BOOL cache83, int default_case, int snum)
601 smb_ucs2_t *OutName_ucs2;
602 magic_char = lp_magicchar(snum);
604 DEBUG(5,("name_map( %s, need83 = %s, cache83 = %s)\n", OutName,
605 need83 ? "True" : "False", cache83 ? "True" : "False"));
607 if (push_ucs2_allocate(&OutName_ucs2, OutName) == (size_t)-1) {
608 DEBUG(0, ("push_ucs2_allocate failed!\n"));
612 if( !need83 && !NT_STATUS_IS_OK(is_valid_name(OutName_ucs2, False, False)))
615 /* check if it's already in 8.3 format */
616 if (need83 && !NT_STATUS_IS_OK(is_8_3_w(OutName_ucs2, False))) {
619 /* mangle it into 8.3 */
621 tmp = SMB_STRDUP(OutName);
623 to_8_3(OutName, default_case);
626 cache_mangled_name(OutName, tmp);
631 DEBUG(5,("name_map() ==> [%s]\n", OutName));
632 SAFE_FREE(OutName_ucs2);
636 the following provides the abstraction layer to make it easier
637 to drop in an alternative mangling implementation
639 static struct mangle_fns mangle_fns = {
647 /* return the methods for this mangling implementation */
648 struct mangle_fns *mangle_hash_init(void)
652 /* Create the in-memory tdb using our custom hash function. */
653 tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
654 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);