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   * @since MINA 2.0.0-M3
44   */
45  public class NTLMTest extends TestCase {
46      private final static Logger logger = LoggerFactory
47              .getLogger(NTLMTest.class);
48  
49      static {
50          if (Security.getProvider("MINA") == null) {
51              Security.addProvider(new MD4Provider());
52          }
53      }
54      
55      /**
56       * Tests bytes manipulations.
57       */
58      public void testEncoding() throws UnsupportedEncodingException {
59          assertEquals("d204", asHex(ByteUtilities.writeShort((short) 1234)));
60          assertEquals("d2040000", asHex(ByteUtilities.writeInt(1234)));
61          assertEquals("01000000", asHex(ByteUtilities.writeInt((short) 1)));
62          assertEquals("4e544c4d53535000", asHex(NTLMUtilities.NTLM_SIGNATURE));
63  
64          assertEquals("680065006c006c006f00", asHex(ByteUtilities
65                  .getUTFStringAsByteArray("hello")));
66          assertEquals("48454c4c4f", asHex(ByteUtilities
67                  .getOEMStringAsByteArray("HELLO")));
68      }
69  
70      /**
71       * Tests conversions to and from network byte order.
72       */
73      public void testMethods() {
74          byte[] buf = new byte[4];
75          ByteUtilities.intToNetworkByteOrder(1234, buf, 0, 4);
76          assertEquals("000004d2", asHex(buf));
77          assertEquals(1234, ByteUtilities.networkByteOrderToInt(buf, 0, 4));
78      }
79  
80      /**
81       * Tests security buffers.
82       */
83      public void testSecurityBuffer() {
84          byte[] secBuf = new byte[8];
85          NTLMUtilities.writeSecurityBuffer((short) 1234, (short) 1234, 4321,
86                  secBuf, 0);
87          assertEquals("d204d204e1100000", asHex(secBuf));
88      }
89  
90      /**
91       * Tests creating a type 1 message.
92       */
93      public void testType1Message() {
94          int customFlags = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
95                  | NTLMUtilities.FLAG_NEGOTIATE_OEM
96                  | NTLMUtilities.FLAG_NEGOTIATE_NTLM
97                  | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
98                  | NTLMUtilities.FLAG_NEGOTIATE_DOMAIN_SUPPLIED
99                  | NTLMUtilities.FLAG_NEGOTIATE_WORKSTATION_SUPPLIED;
100 
101         byte[] osVer = new byte[8];
102         NTLMUtilities
103                 .writeOSVersion((byte) 5, (byte) 0, (short) 2195, osVer, 0);
104 
105         String msgType1 = asHex(NTLMUtilities.createType1Message("WORKSTATION",
106                 "DOMAIN", customFlags, osVer));
107         assertEquals(
108                 "4e544c4d53535000010000000732000006000600330000000b000b0028000000"
109                         + "050093080000000f574f524b53544154494f4e444f4d41494e",
110                 msgType1);
111 
112         assertEquals("050093080000000f", asHex(osVer));
113         
114         //Microsoft Windows XP [version 5.1.2600]
115         String os = System.getProperty("os.name");
116         if (os != null && os.toUpperCase().contains("WINDOWS") && 
117                 "5.1".equals(System.getProperty("os.version"))) {
118             String hex = asHex(NTLMUtilities.getOsVersion());
119             assertEquals("0501", hex.substring(0, 4));
120             assertEquals(16, hex.length());
121         }
122     }
123 
124     /**
125      * Tests creating a type 3 message.
126      * WARNING: Will silently fail if no MD4 digest provider is available.
127      */
128     public void testType3Message() throws Exception {
129         try {
130             MessageDigest.getInstance("MD4");
131         } catch (NoSuchAlgorithmException ex) {
132             logger.warn("No MD4 digest provider found !");
133             return;
134         }
135 
136         int flags = 0x00000001 | 0x00000200 | 0x00010000 | 0x00800000;
137         String msg = "4e544c4d53535000020000000c000c003000000001028100"
138                 + "0123456789abcdef0000000000000000620062003c000000"
139                 + "44004f004d00410049004e0002000c0044004f004d004100"
140                 + "49004e0001000c0053004500520056004500520004001400"
141                 + "64006f006d00610069006e002e0063006f006d0003002200"
142                 + "7300650072007600650072002e0064006f006d0061006900"
143                 + "6e002e0063006f006d0000000000";
144 
145         byte[] challengePacket = ByteUtilities.asByteArray(msg);
146         int serverFlags = NTLMUtilities
147                 .extractFlagsFromType2Message(challengePacket);
148         assertEquals(flags, serverFlags);
149 
150         NTLMUtilities
151                 .printTargetInformationBlockFromType2Message(challengePacket,
152                         serverFlags, new PrintWriter(System.out, true));
153 
154         byte[] osVer = new byte[8];
155         NTLMUtilities
156                 .writeOSVersion((byte) 5, (byte) 0, (short) 2195, osVer, 0);
157 
158         byte[] challenge = NTLMUtilities
159                 .extractChallengeFromType2Message(challengePacket);
160         assertEquals("0123456789abcdef", asHex(challenge));
161 
162         String expectedTargetInfoBlock = "02000c0044004f004d00410049004e00"
163                 + "01000c00530045005200560045005200"
164                 + "0400140064006f006d00610069006e00"
165                 + "2e0063006f006d000300220073006500"
166                 + "72007600650072002e0064006f006d00"
167                 + "610069006e002e0063006f006d000000" + "0000";
168 
169         byte[] targetInfo = NTLMUtilities.extractTargetInfoFromType2Message(
170                 challengePacket, null);
171         assertEquals(expectedTargetInfoBlock, asHex(targetInfo));
172 
173         assertEquals("DOMAIN", NTLMUtilities.extractTargetNameFromType2Message(
174                 challengePacket, new Integer(serverFlags)));
175 
176         serverFlags = 0x00000001 | 0x00000200;
177         String msgType3 = asHex(NTLMUtilities.createType3Message("user",
178                 "SecREt01", challenge, "DOMAIN", "WORKSTATION", serverFlags,
179                 null));
180 
181         String expected = "4e544c4d5353500003000000180018006a00000018001800"
182                 + "820000000c000c0040000000080008004c00000016001600"
183                 + "54000000000000009a0000000102000044004f004d004100"
184                 + "49004e00750073006500720057004f0052004b0053005400"
185                 + "4100540049004f004e00c337cd5cbd44fc9782a667af6d42"
186                 + "7c6de67c20c2d3e77c5625a98c1c31e81847466b29b2df46"
187                 + "80f39958fb8c213a9cc6";
188         assertEquals(expected, msgType3);
189     }
190 
191     /**
192      * Tests flags manipulations.
193      */
194     public void testFlags() {
195         int flags = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
196                 | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
197                 | NTLMUtilities.FLAG_NEGOTIATE_NTLM
198                 | NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN;
199 
200         int flags2 = NTLMUtilities.FLAG_NEGOTIATE_UNICODE
201                 | NTLMUtilities.FLAG_REQUEST_SERVER_AUTH_REALM
202                 | NTLMUtilities.FLAG_NEGOTIATE_NTLM;
203 
204         assertEquals(flags2, flags
205                 & (~NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN));
206         assertEquals(flags2, flags2
207                 & (~NTLMUtilities.FLAG_NEGOTIATE_ALWAYS_SIGN));
208         assertEquals("05820000", asHex(ByteUtilities.writeInt(flags)));
209 
210         byte[] testFlags = ByteUtilities.asByteArray("7F808182");
211         assertEquals("7f808182", asHex(testFlags));
212         ByteUtilities.changeByteEndianess(testFlags, 0, 4);
213         assertEquals("807f8281", asHex(testFlags));
214         ByteUtilities.changeByteEndianess(testFlags, 0, 4);
215         ByteUtilities.changeWordEndianess(testFlags, 0, 4);
216         assertEquals("8281807f", asHex(testFlags));
217     }
218 
219     /**
220      * Tests response computing.
221      * WARNING: Will silently fail if no MD4 digest provider is available.
222      */
223     public void testResponses() throws Exception {
224         try {
225             MessageDigest.getInstance("MD4");
226         } catch (NoSuchAlgorithmException ex) {
227             logger.warn("No MD4 digest provider found !");
228             return;
229         }
230 
231         String LMResponse = "c337cd5cbd44fc9782a667af6d427c6de67c20c2d3e77c56";
232 
233         assertEquals(LMResponse, asHex(NTLMResponses.getLMResponse("SecREt01",
234                 ByteUtilities.asByteArray("0123456789abcdef"))));
235 
236         String NTLMResponse = "25a98c1c31e81847466b29b2df4680f39958fb8c213a9cc6";
237 
238         assertEquals(NTLMResponse, asHex(NTLMResponses.getNTLMResponse(
239                 "SecREt01", ByteUtilities.asByteArray("0123456789abcdef"))));
240 
241         String LMv2Response = "d6e6152ea25d03b7c6ba6629c2d6aaf0ffffff0011223344";
242 
243         assertEquals(LMv2Response, asHex(NTLMResponses.getLMv2Response(
244                 "DOMAIN", "user", "SecREt01", ByteUtilities
245                         .asByteArray("0123456789abcdef"), ByteUtilities
246                         .asByteArray("ffffff0011223344"))));
247 
248         String NTLM2Response = "10d550832d12b2ccb79d5ad1f4eed3df82aca4c3681dd455";
249 
250         assertEquals(NTLM2Response, asHex(NTLMResponses
251                 .getNTLM2SessionResponse("SecREt01", ByteUtilities
252                         .asByteArray("0123456789abcdef"), ByteUtilities
253                         .asByteArray("ffffff0011223344"))));
254 
255         String NTLMv2Response = "cbabbca713eb795d04c97abc01ee4983"
256                 + "01010000000000000090d336b734c301"
257                 + "ffffff00112233440000000002000c00"
258                 + "44004f004d00410049004e0001000c00"
259                 + "53004500520056004500520004001400"
260                 + "64006f006d00610069006e002e006300"
261                 + "6f006d00030022007300650072007600"
262                 + "650072002e0064006f006d0061006900"
263                 + "6e002e0063006f006d00000000000000" + "0000";
264 
265         String targetInformation = "02000c0044004f004d00410049004e00"
266                 + "01000c00530045005200560045005200"
267                 + "0400140064006f006d00610069006e00"
268                 + "2e0063006f006d000300220073006500"
269                 + "72007600650072002e0064006f006d00"
270                 + "610069006e002e0063006f006d000000" + "0000";
271 
272         assertEquals(NTLMv2Response, asHex(NTLMResponses.getNTLMv2Response(
273                 "DOMAIN", "user", "SecREt01", ByteUtilities
274                         .asByteArray(targetInformation), ByteUtilities
275                         .asByteArray("0123456789abcdef"), ByteUtilities
276                         .asByteArray("ffffff0011223344"), 1055844000000L)));
277     }
278 }