dos8dot3.c File Reference

#include <rtl.h>
#include <debug.h>

Include dependency graph for dos8dot3.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
BOOLEAN NTAPI	RtlIsValidOemCharacter (IN PWCHAR Char)
static BOOLEAN	RtlpIsShortIllegal (const WCHAR Char)
static USHORT	RtlpGetCheckSum (PUNICODE_STRING Name)
VOID NTAPI	RtlGenerate8dot3Name (IN PUNICODE_STRING Name, IN BOOLEAN AllowExtendedCharacters, IN OUT PGENERATE_NAME_CONTEXT Context, OUT PUNICODE_STRING Name8dot3)
	_IRQL_requires_max_ (PASSIVE_LEVEL)
	Queries information details about a security descriptor.

Variables
PUSHORT	NlsUnicodeToMbOemTable
const ULONG	RtlpShortIllegals [] = { 0xFFFFFFFF, 0xFC009C04, 0x38000000, 0x10000000 }

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file dos8dot3.c.

Function Documentation

_IRQL_requires_max_()

_IRQL_requires_max_

(

PASSIVE_LEVEL

)

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in]

SecurityDescriptor

A security descriptor to be freed from memory.

Returns

Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns

Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 244 of file dos8dot3.c.

{
    static const char Illegal[] = "*?<>|\"+=,;[]:/\\\345";
    int Dot = -1;
    int i;
    char Buffer[12];
    OEM_STRING OemString;
    BOOLEAN GotSpace = FALSE;
    NTSTATUS Status;
 
    if (!OemName)
    {
        OemString.Length = sizeof(Buffer);
        OemString.MaximumLength = sizeof(Buffer);
        OemString.Buffer = Buffer;
        OemName = &OemString;
    }
 
    Status = RtlUpcaseUnicodeStringToCountedOemString(OemName, Name, FALSE);
    if (!NT_SUCCESS(Status))
        return FALSE;
 
    if ((OemName->Length > 12) || (OemName->Buffer == NULL)) return FALSE;
 
    /* a starting . is invalid, except for . and .. */
    if (OemName->Buffer[0] == '.')
    {
        if (OemName->Length != 1 && (OemName->Length != 2 || OemName->Buffer[1] != '.')) return FALSE;
        if (NameContainsSpaces) *NameContainsSpaces = FALSE;
 
        return TRUE;
    }
 
    for (i = 0; i < OemName->Length; i++)
    {
        switch (OemName->Buffer[i])
        {
            case ' ':
                /* leading/trailing spaces not allowed */
                if (!i || i == OemName->Length-1 || OemName->Buffer[i+1] == '.') return FALSE;
                GotSpace = TRUE;
                break;
 
            case '.':
                if (Dot != -1) return FALSE;
                Dot = i;
                break;
 
            default:
                if (strchr(Illegal, OemName->Buffer[i])) return FALSE;
                break;
        }
    }
    /* check file part is shorter than 8, extension shorter than 3
     * dot cannot be last in string
     */
    if (Dot == -1)
    {
        if (OemName->Length > 8) return FALSE;
    }
    else
    {
        if (Dot > 8 || (OemName->Length - Dot > 4) || Dot == OemName->Length - 1) return FALSE;
    }
 
    if (NameContainsSpaces) *NameContainsSpaces = GotSpace;
 
    return TRUE;
}

RtlGenerate8dot3Name()

VOID NTAPI RtlGenerate8dot3Name	(	IN PUNICODE_STRING	Name,
		IN BOOLEAN	AllowExtendedCharacters,
		IN OUT PGENERATE_NAME_CONTEXT	Context,
		OUT PUNICODE_STRING	Name8dot3
	)

Definition at line 81 of file dos8dot3.c.

{
    ULONG Length = Name->Length / sizeof(WCHAR);
    ULONG IndexLength;
    ULONG Index;
    ULONG DotPos;
    WCHAR IndexBuffer[8];
    WCHAR Char;
    USHORT Checksum;
 
    if (!Context->NameLength)
    {
        DotPos = Length;
 
        /* Find last dot in Name */
        for (Index = 0; Index < Length; Index++)
        {
            if (Name->Buffer[Index] == L'.')
                DotPos = Index;
        }
 
        /* Copy name. OEM string length can't exceed 6. */
        UCHAR OemSizeLeft = 6;
        for (Index = 0; (Index < DotPos) && OemSizeLeft; Index++)
        {
            Char = Name->Buffer[Index];
 
            if ((Char > L' ') && (Char != L'.') &&
                ((Char < 127) || (AllowExtendedCharacters && RtlIsValidOemCharacter(&Char))))
            {
                if (RtlpIsShortIllegal(Char))
                    Char = L'_';
                else if (Char >= L'a' && Char <= L'z')
                    Char = RtlpUpcaseUnicodeChar(Char);
 
                /* Beware of MB OEM codepage */
                if (NlsMbOemCodePageTag && HIBYTE(NlsUnicodeToMbOemTable[Char]))
                {
                    if (OemSizeLeft < 2)
                        break;
                    OemSizeLeft--;
                }
 
                Context->NameBuffer[Context->NameLength] = Char;
                Context->NameLength++;
                OemSizeLeft--;
            }
        }
 
        /* Copy extension (4 valid characters max) */
        Context->ExtensionLength = 0;
        if (DotPos < Length)
        {
            Context->ExtensionBuffer[0] = L'.';
            Context->ExtensionLength = 1;
 
            while (DotPos < Length && Context->ExtensionLength < 4)
            {
                Char = Name->Buffer[DotPos];
 
                if ((Char > L' ') && (Char != L'.') &&
                    ((Char < 127) || (AllowExtendedCharacters && RtlIsValidOemCharacter(&Char))))
                {
                    if (RtlpIsShortIllegal(Char))
                        Char = L'_';
                    else if (Char >= L'a' && Char <= L'z')
                        Char = RtlpUpcaseUnicodeChar(Char);
 
                    Context->ExtensionBuffer[Context->ExtensionLength++] = Char;
                }
 
                Char = UNICODE_NULL;
                ++DotPos;
            }
 
            if (Char != UNICODE_NULL)
                Context->ExtensionBuffer[Context->ExtensionLength - 1] = L'~';
        }
 
        if (Context->NameLength <= 2)
        {
            Checksum = Context->Checksum = RtlpGetCheckSum(Name);
 
            for (Index = 0; Index < 4; Index++)
            {
                Context->NameBuffer[Context->NameLength + Index] =
                    (Checksum & 0xF) > 9 ? (Checksum & 0xF) + L'A' - 10 : (Checksum & 0xF) + L'0';
                Checksum >>= 4;
            }
 
            Context->CheckSumInserted = TRUE;
            Context->NameLength += 4;
        }
    }
 
    ++Context->LastIndexValue;
 
    if (Context->LastIndexValue > 4 && !Context->CheckSumInserted)
    {
        Checksum = Context->Checksum = RtlpGetCheckSum(Name);
 
        for (Index = 2; Index < 6; Index++)
        {
            Context->NameBuffer[Index] =
                (Checksum & 0xF) > 9 ? (Checksum & 0xF) + L'A' - 10 : (Checksum & 0xF) + L'0';
            Checksum >>= 4;
        }
 
        Context->CheckSumInserted = TRUE;
        Context->NameLength = 6;
        Context->LastIndexValue = 1;
    }
 
    /* Calculate index length and index buffer */
    Index = Context->LastIndexValue;
    for (IndexLength = 1; IndexLength <= 7 && Index > 0; IndexLength++)
    {
        IndexBuffer[8 - IndexLength] = L'0' + (Index % 10);
        Index /= 10;
    }
 
    IndexBuffer[8 - IndexLength] = L'~';
 
    /* Reset name length */
    Name8dot3->Length = 0;
 
    /* If name present */
    if (Context->NameLength)
    {
        /* Copy name buffer */
        Length = Context->NameLength * sizeof(WCHAR);
        RtlCopyMemory(Name8dot3->Buffer, Context->NameBuffer, Length);
        Name8dot3->Length = Length;
    }
 
    /* Copy index buffer */
    Length = IndexLength * sizeof(WCHAR);
    RtlCopyMemory(Name8dot3->Buffer + (Name8dot3->Length / sizeof(WCHAR)),
                  IndexBuffer + (8 - IndexLength),
                  Length);
    Name8dot3->Length += Length;
 
    /* If extension present */
    if (Context->ExtensionLength)
    {
        /* Copy extension buffer */
        Length = Context->ExtensionLength * sizeof(WCHAR);
        RtlCopyMemory(Name8dot3->Buffer + (Name8dot3->Length / sizeof(WCHAR)),
                      Context->ExtensionBuffer,
                      Length);
        Name8dot3->Length += Length;
    }
}

RtlIsValidOemCharacter()

BOOLEAN NTAPI RtlIsValidOemCharacter

(

IN PWCHAR

Char

)

Definition at line 514 of file unicode.c.

{
    WCHAR UnicodeChar;
    WCHAR OemChar;
 
    /* If multi-byte code page present */
    if (NlsMbOemCodePageTag)
    {
        USHORT Offset;
 
        OemChar = NlsUnicodeToMbOemTable[*Char];
 
        /* If character has Lead Byte */
        Offset = NlsOemLeadByteInfo[HIBYTE(OemChar)];
        if (Offset)
        {
            /* Use DBCS table */
            UnicodeChar = NlsOemLeadByteInfo[Offset + LOBYTE(OemChar)];
        }
        else
        {
            UnicodeChar = NlsOemToUnicodeTable[OemChar];
        }
 
        /* Upcase */
        UnicodeChar = RtlpUpcaseUnicodeChar(UnicodeChar);
 
        /* Receive OEM character from the table */
        OemChar = NlsUnicodeToMbOemTable[UnicodeChar];
    }
    else
    {
        /* Receive Unicode character from the table */
        UnicodeChar = RtlpUpcaseUnicodeChar(NlsOemToUnicodeTable[(UCHAR)NlsUnicodeToOemTable[*Char]]);
 
        /* Receive OEM character from the table */
        OemChar = NlsUnicodeToOemTable[UnicodeChar];
    }
 
    /* Not valid character, failed */
    if (OemChar == NlsOemDefaultChar)
    {
        DPRINT1("\\u%04x is not valid for OEM\n", *Char);
        return FALSE;
    }
 
    *Char = UnicodeChar;
 
    return TRUE;
}

Referenced by RtlGenerate8dot3Name(), and START_TEST().

RtlpGetCheckSum()

static USHORT RtlpGetCheckSum ( PUNICODE_STRING  Name )

static

Definition at line 35 of file dos8dot3.c.

{
    PWCHAR CurrentChar;
    USHORT Hash;
    USHORT Saved;
    USHORT Length;
 
    if (!Name->Length)
        return 0;
 
    if (Name->Length == sizeof(WCHAR))
        return Name->Buffer[0];
 
    CurrentChar = Name->Buffer;
    Hash = (*CurrentChar << 8) + *(CurrentChar + 1);
 
    if (Name->Length == 2 * sizeof(WCHAR))
        return Hash;
 
    Saved = Hash;
    Length = 2;
 
    do
    {
        CurrentChar += 2;
        Hash = (Hash << 7) + *CurrentChar;
        Hash = (Saved >> 1) + (Hash << 8);
 
        if (Length + 1 < Name->Length / sizeof(WCHAR))
        {
            Hash += *(CurrentChar + 1);
        }
 
        Saved = Hash;
        Length += 2;
    }
    while (Length < Name->Length / sizeof(WCHAR));
 
    return Hash;
}

Referenced by RtlGenerate8dot3Name().

RtlpIsShortIllegal()

static BOOLEAN RtlpIsShortIllegal ( const WCHAR  Char )

static

Definition at line 29 of file dos8dot3.c.

{
    return (Char < 128 && (RtlpShortIllegals[Char / 32] & (1 << (Char % 32))));
}

Referenced by RtlGenerate8dot3Name().

Variable Documentation

NlsUnicodeToMbOemTable

PUSHORT NlsUnicodeToMbOemTable

extern

Definition at line 22 of file nlsboot.c.

Referenced by RtlGenerate8dot3Name().

RtlpShortIllegals

const ULONG RtlpShortIllegals[] = { 0xFFFFFFFF, 0xFC009C04, 0x38000000, 0x10000000 }

Definition at line 20 of file dos8dot3.c.

Referenced by RtlpIsShortIllegal().