1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.proxy;
21  
22  import static org.apache.mina.proxy.utils.ByteUtilities.asHex;
23  
24  import java.io.PrintWriter;
25  import java.io.UnsupportedEncodingException;
26  import java.security.MessageDigest;
27  import java.security.NoSuchAlgorithmException;
28  import java.security.Security;
29  
30  import junit.framework.TestCase;
31  
32  import org.apache.mina.proxy.handlers.http.ntlm.NTLMResponses;
33  import org.apache.mina.proxy.handlers.http.ntlm.NTLMUtilities;
34  import org.apache.mina.proxy.utils.ByteUtilities;
35  import org.apache.mina.proxy.utils.MD4Provider;
36  import org.slf4j.Logger;
37  import org.slf4j.LoggerFactory;
38  
39  /**
40   * NTLMTest.java - JUNIT tests of the NTLM authentication mechanism.
41   * 
42   * @author The Apache MINA Project (dev@mina.apache.org)
43   * @version $Rev: 718829 $, $Date: 2008-11-19 02:08:21 +0100 (Wed, 19 Nov 2008) $
44   * @since MINA 2.0.0-M3
45   */
46  public class NTLMTest extends TestCase {
47      private final static Logger logger = LoggerFactory
48              .getLogger(NTLMTest.class);
49  
50      static {
51          if (Security.getProvider("MINA") == null) {
52              Security.addProvider(new MD4Provider());
53          }
54      }
55      
56      /**
57       * Tests bytes manipulations.
58       */
59      public void testEncoding() throws UnsupportedEncodingException {
60          assertEquals("d204", asHex(ByteUtilities.writeShort((short) 1234)));
61          assertEquals("d2040000", asHex(ByteUtilities.writeInt(1234)));
62          assertEquals("01000000", asHex(ByteUtilities.writeInt((short) 1)));
63          assertEquals("4e544c4d53535000", asHex(NTLMUtilities.NTLM_SIGNATURE));
64  
65          assertEquals("680065006c006c006f00", asHex(ByteUtilities
66                  .getUTFStringAsByteArray("hello")));
67          assertEquals("48454c4c4f", asHex(ByteUtilities
68                  .getOEMStringAsByteArray("HELLO")));
69      }
70  
71      /**
72       * Tests conversions to and from network byte order.
73       */
74      public void testMethods() {
75          byte[] buf = new byte[4];
76          ByteUtilities.intToNetworkByteOrder(1234, buf, 0, 4);
77          assertEquals("000004d2", asHex(buf));
78          assertEquals(1234, ByteUtilities.networkByteOrderToInt(buf, 0, 4));
79      }
80  
81      /**
82       * Tests security buffers.
83       */
84      public void testSecurityBuffer() {
85          byte[] secBuf = new byte[8];
86          NTLMUtilities.writeSecurityBuffer((short) 1234, (short) 1234, 4321,
87                  secBuf, 0);
88          assertEquals("d204d204e1100000", asHex(secBuf));
89      }
90  
91      /**
92       * Tests creating a type 1 message.
93       */
94      public void testType1Message() {
95          int customFlags = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
96                  | NTLMUtilities.FLAG_NEGOTIATE_OEM
97                  | NTLMUtilities.FLAG_NEGOTIATE_NTLM
98                  | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
99                  | NTLMUtilities.FLAG_NEGOTIATE_DOMAIN_SUPPLIED
100                 | NTLMUtilities.FLAG_NEGOTIATE_WORKSTATION_SUPPLIED;
101 
102         byte[] osVer = new byte[8];
103         NTLMUtilities
104                 .writeOSVersion((byte) 5, (byte) 0, (short) 2195, osVer, 0);
105 
106         String msgType1 = asHex(NTLMUtilities.createType1Message("WORKSTATION",
107                 "DOMAIN", customFlags, osVer));
108         assertEquals(
109                 "4e544c4d53535000010000000732000006000600330000000b000b0028000000"
110                         + "050093080000000f574f524b53544154494f4e444f4d41494e",
111                 msgType1);
112 
113         assertEquals("050093080000000f", asHex(osVer));
114         
115         //Microsoft Windows XP [version 5.1.2600]
116         String os = System.getProperty("os.name");
117         if (os != null && os.toUpperCase().contains("WINDOWS") && 
118                 "5.1".equals(System.getProperty("os.version"))) {
119             assertEquals("0501280a0000000f", asHex(NTLMUtilities.getOsVersion()));
120         }
121     }
122 
123     /**
124      * Tests creating a type 3 message.
125      * WARNING: Will silently fail if no MD4 digest provider is available.
126      */
127     public void testType3Message() throws Exception {
128         try {
129             MessageDigest.getInstance("MD4");
130         } catch (NoSuchAlgorithmException ex) {
131             logger.warn("No MD4 digest provider found !");
132             return;
133         }
134 
135         int flags = 0x00000001 | 0x00000200 | 0x00010000 | 0x00800000;
136         String msg = "4e544c4d53535000020000000c000c003000000001028100"
137                 + "0123456789abcdef0000000000000000620062003c000000"
138                 + "44004f004d00410049004e0002000c0044004f004d004100"
139                 + "49004e0001000c0053004500520056004500520004001400"
140                 + "64006f006d00610069006e002e0063006f006d0003002200"
141                 + "7300650072007600650072002e0064006f006d0061006900"
142                 + "6e002e0063006f006d0000000000";
143 
144         byte[] challengePacket = ByteUtilities.asByteArray(msg);
145         int serverFlags = NTLMUtilities
146                 .extractFlagsFromType2Message(challengePacket);
147         assertEquals(flags, serverFlags);
148 
149         NTLMUtilities
150                 .printTargetInformationBlockFromType2Message(challengePacket,
151                         serverFlags, new PrintWriter(System.out, true));
152 
153         byte[] osVer = new byte[8];
154         NTLMUtilities
155                 .writeOSVersion((byte) 5, (byte) 0, (short) 2195, osVer, 0);
156 
157         byte[] challenge = NTLMUtilities
158                 .extractChallengeFromType2Message(challengePacket);
159         assertEquals("0123456789abcdef", asHex(challenge));
160 
161         String expectedTargetInfoBlock = "02000c0044004f004d00410049004e00"
162                 + "01000c00530045005200560045005200"
163                 + "0400140064006f006d00610069006e00"
164                 + "2e0063006f006d000300220073006500"
165                 + "72007600650072002e0064006f006d00"
166                 + "610069006e002e0063006f006d000000" + "0000";
167 
168         byte[] targetInfo = NTLMUtilities.extractTargetInfoFromType2Message(
169                 challengePacket, null);
170         assertEquals(expectedTargetInfoBlock, asHex(targetInfo));
171 
172         assertEquals("DOMAIN", NTLMUtilities.extractTargetNameFromType2Message(
173                 challengePacket, new Integer(serverFlags)));
174 
175         serverFlags = 0x00000001 | 0x00000200;
176         String msgType3 = asHex(NTLMUtilities.createType3Message("user",
177                 "SecREt01", challenge, "DOMAIN", "WORKSTATION", serverFlags,
178                 null));
179 
180         String expected = "4e544c4d5353500003000000180018006a00000018001800"
181                 + "820000000c000c0040000000080008004c00000016001600"
182                 + "54000000000000009a0000000102000044004f004d004100"
183                 + "49004e00750073006500720057004f0052004b0053005400"
184                 + "4100540049004f004e00c337cd5cbd44fc9782a667af6d42"
185                 + "7c6de67c20c2d3e77c5625a98c1c31e81847466b29b2df46"
186                 + "80f39958fb8c213a9cc6";
187         assertEquals(expected, msgType3);
188     }
189 
190     /**
191      * Tests flags manipulations.
192      */
193     public void testFlags() {
194         int flags = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
195                 | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
196                 | NTLMUtilities.FLAG_NEGOTIATE_NTLM
197                 | NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN;
198 
199         int flags2 = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
200                 | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
201                 | NTLMUtilities.FLAG_NEGOTIATE_NTLM;
202 
203         assertEquals(flags2, flags
204                 & (~NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN));
205         assertEquals(flags2, flags2
206                 & (~NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN));
207         assertEquals("05820000", asHex(ByteUtilities.writeInt(flags)));
208 
209         byte[] testFlags = ByteUtilities.asByteArray("7F808182");
210         assertEquals("7f808182", asHex(testFlags));
211         ByteUtilities.changeByteEndianess(testFlags, 0, 4);
212         assertEquals("807f8281", asHex(testFlags));
213         ByteUtilities.changeByteEndianess(testFlags, 0, 4);
214         ByteUtilities.changeWordEndianess(testFlags, 0, 4);
215         assertEquals("8281807f", asHex(testFlags));
216     }
217 
218     /**
219      * Tests response computing.
220      * WARNING: Will silently fail if no MD4 digest provider is available.
221      */
222     public void testResponses() throws Exception {
223         try {
224             MessageDigest.getInstance("MD4");
225         } catch (NoSuchAlgorithmException ex) {
226             logger.warn("No MD4 digest provider found !");
227             return;
228         }
229 
230         String LMResponse = "c337cd5cbd44fc9782a667af6d427c6de67c20c2d3e77c56";
231 
232         assertEquals(LMResponse, asHex(NTLMResponses.getLMResponse("SecREt01",
233                 ByteUtilities.asByteArray("0123456789abcdef"))));
234 
235         String NTLMResponse = "25a98c1c31e81847466b29b2df4680f39958fb8c213a9cc6";
236 
237         assertEquals(NTLMResponse, asHex(NTLMResponses.getNTLMResponse(
238                 "SecREt01", ByteUtilities.asByteArray("0123456789abcdef"))));
239 
240         String LMv2Response = "d6e6152ea25d03b7c6ba6629c2d6aaf0ffffff0011223344";
241 
242         assertEquals(LMv2Response, asHex(NTLMResponses.getLMv2Response(
243                 "DOMAIN", "user", "SecREt01", ByteUtilities
244                         .asByteArray("0123456789abcdef"), ByteUtilities
245                         .asByteArray("ffffff0011223344"))));
246 
247         String NTLM2Response = "10d550832d12b2ccb79d5ad1f4eed3df82aca4c3681dd455";
248 
249         assertEquals(NTLM2Response, asHex(NTLMResponses
250                 .getNTLM2SessionResponse("SecREt01", ByteUtilities
251                         .asByteArray("0123456789abcdef"), ByteUtilities
252                         .asByteArray("ffffff0011223344"))));
253 
254         String NTLMv2Response = "cbabbca713eb795d04c97abc01ee4983"
255                 + "01010000000000000090d336b734c301"
256                 + "ffffff00112233440000000002000c00"
257                 + "44004f004d00410049004e0001000c00"
258                 + "53004500520056004500520004001400"
259                 + "64006f006d00610069006e002e006300"
260                 + "6f006d00030022007300650072007600"
261                 + "650072002e0064006f006d0061006900"
262                 + "6e002e0063006f006d00000000000000" + "0000";
263 
264         String targetInformation = "02000c0044004f004d00410049004e00"
265                 + "01000c00530045005200560045005200"
266                 + "0400140064006f006d00610069006e00"
267                 + "2e0063006f006d000300220073006500"
268                 + "72007600650072002e0064006f006d00"
269                 + "610069006e002e0063006f006d000000" + "0000";
270 
271         assertEquals(NTLMv2Response, asHex(NTLMResponses.getNTLMv2Response(
272                 "DOMAIN", "user", "SecREt01", ByteUtilities
273                         .asByteArray(targetInformation), ByteUtilities
274                         .asByteArray("0123456789abcdef"), ByteUtilities
275                         .asByteArray("ffffff0011223344"), 1055844000000L)));
276     }
277 }