Merge branch 'docs' of git://git.lwn.net/linux-2.6
[linux-2.6] / fs / cifs / ntlmssp.h
1 /*
2  *   fs/cifs/ntlmssp.h
3  *
4  *   Copyright (c) International Business Machines  Corp., 2002,2007
5  *   Author(s): Steve French (sfrench@us.ibm.com)
6  *
7  *   This library is free software; you can redistribute it and/or modify
8  *   it under the terms of the GNU Lesser General Public License as published
9  *   by the Free Software Foundation; either version 2.1 of the License, or
10  *   (at your option) any later version.
11  *
12  *   This library is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
15  *   the GNU Lesser General Public License for more details.
16  *
17  *   You should have received a copy of the GNU Lesser General Public License
18  *   along with this library; if not, write to the Free Software
19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */
21
22 #define NTLMSSP_SIGNATURE "NTLMSSP"
23 /* Message Types */
24 #define NtLmNegotiate     cpu_to_le32(1)
25 #define NtLmChallenge     cpu_to_le32(2)
26 #define NtLmAuthenticate  cpu_to_le32(3)
27 #define UnknownMessage    cpu_to_le32(8)
28
29 /* Negotiate Flags */
30 #define NTLMSSP_NEGOTIATE_UNICODE       0x01 /* Text strings are in unicode */
31 #define NTLMSSP_NEGOTIATE_OEM           0x02 /* Text strings are in OEM */
32 #define NTLMSSP_REQUEST_TARGET          0x04 /* Server return its auth realm */
33 #define NTLMSSP_NEGOTIATE_SIGN        0x0010 /* Request signature capability */
34 #define NTLMSSP_NEGOTIATE_SEAL        0x0020 /*  Request confidentiality */
35 #define NTLMSSP_NEGOTIATE_DGRAM       0x0040
36 #define NTLMSSP_NEGOTIATE_LM_KEY      0x0080 /* Sign/seal use LM session key */
37 #define NTLMSSP_NEGOTIATE_NTLM        0x0200 /* NTLM authentication */
38 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED 0x1000
39 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x2000
40 #define NTLMSSP_NEGOTIATE_LOCAL_CALL  0x4000 /* client/server on same machine */
41 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN 0x8000 /* Sign for all security levels */
42 #define NTLMSSP_TARGET_TYPE_DOMAIN   0x10000
43 #define NTLMSSP_TARGET_TYPE_SERVER   0x20000
44 #define NTLMSSP_TARGET_TYPE_SHARE    0x40000
45 #define NTLMSSP_NEGOTIATE_NTLMV2     0x80000
46 #define NTLMSSP_REQUEST_INIT_RESP   0x100000
47 #define NTLMSSP_REQUEST_ACCEPT_RESP 0x200000
48 #define NTLMSSP_REQUEST_NOT_NT_KEY  0x400000
49 #define NTLMSSP_NEGOTIATE_TARGET_INFO 0x800000
50 #define NTLMSSP_NEGOTIATE_128     0x20000000
51 #define NTLMSSP_NEGOTIATE_KEY_XCH 0x40000000
52 #define NTLMSSP_NEGOTIATE_56      0x80000000
53
54 /* Although typedefs are not commonly used for structure definitions */
55 /* in the Linux kernel, in this particular case they are useful      */
56 /* to more closely match the standards document for NTLMSSP from     */
57 /* OpenGroup and to make the code more closely match the standard in */
58 /* appearance */
59
60 typedef struct _SECURITY_BUFFER {
61         __le16 Length;
62         __le16 MaximumLength;
63         __le32 Buffer;          /* offset to buffer */
64 } __attribute__((packed)) SECURITY_BUFFER;
65
66 typedef struct _NEGOTIATE_MESSAGE {
67         __u8 Signature[sizeof (NTLMSSP_SIGNATURE)];
68         __le32 MessageType;     /* 1 */
69         __le32 NegotiateFlags;
70         SECURITY_BUFFER DomainName;     /* RFC 1001 style and ASCII */
71         SECURITY_BUFFER WorkstationName;        /* RFC 1001 and ASCII */
72         char DomainString[0];
73         /* followed by WorkstationString */
74 } __attribute__((packed)) NEGOTIATE_MESSAGE, *PNEGOTIATE_MESSAGE;
75
76 typedef struct _CHALLENGE_MESSAGE {
77         __u8 Signature[sizeof (NTLMSSP_SIGNATURE)];
78         __le32 MessageType;   /* 2 */
79         SECURITY_BUFFER TargetName;
80         __le32 NegotiateFlags;
81         __u8 Challenge[CIFS_CRYPTO_KEY_SIZE];
82         __u8 Reserved[8];
83         SECURITY_BUFFER TargetInfoArray;
84 } __attribute__((packed)) CHALLENGE_MESSAGE, *PCHALLENGE_MESSAGE;
85
86 typedef struct _AUTHENTICATE_MESSAGE {
87         __u8 Signature[sizeof (NTLMSSP_SIGNATURE)];
88         __le32 MessageType;  /* 3 */
89         SECURITY_BUFFER LmChallengeResponse;
90         SECURITY_BUFFER NtChallengeResponse;
91         SECURITY_BUFFER DomainName;
92         SECURITY_BUFFER UserName;
93         SECURITY_BUFFER WorkstationName;
94         SECURITY_BUFFER SessionKey;
95         __le32 NegotiateFlags;
96         char UserString[0];
97 } __attribute__((packed)) AUTHENTICATE_MESSAGE, *PAUTHENTICATE_MESSAGE;