View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.handler.codec.socks;
17  
18  import org.jboss.netty.buffer.ChannelBuffer;
19  import org.jboss.netty.channel.Channel;
20  import org.jboss.netty.channel.ChannelHandlerContext;
21  import org.jboss.netty.handler.codec.replay.ReplayingDecoder;
22  import org.jboss.netty.util.CharsetUtil;
23  
24  /**
25   * Decodes {@link ChannelBuffer}s into {@link SocksAuthRequest}.
26   * Before returning SocksRequest decoder removes itself from pipeline.
27   */
28  public class SocksAuthRequestDecoder extends ReplayingDecoder<SocksAuthRequestDecoder.State> {
29      private static final String name = "SOCKS_AUTH_REQUEST_DECODER";
30  
31      public static String getName() {
32          return name;
33      }
34  
35      private SocksMessage.SubnegotiationVersion version;
36      private int fieldLength;
37      private String username;
38      private String password;
39      private SocksRequest msg = SocksCommonUtils.UNKNOWN_SOCKS_REQUEST;
40  
41      public SocksAuthRequestDecoder() {
42          super(State.CHECK_PROTOCOL_VERSION);
43      }
44  
45      @Override
46      protected Object decode(ChannelHandlerContext ctx, Channel channel,
47                              ChannelBuffer buffer, State state) throws Exception {
48          switch (state) {
49              case CHECK_PROTOCOL_VERSION: {
50                  version = SocksMessage.SubnegotiationVersion.fromByte(buffer.readByte());
51                  if (version != SocksMessage.SubnegotiationVersion.AUTH_PASSWORD) {
52                      break;
53                  }
54                  checkpoint(State.READ_USERNAME);
55              }
56              case READ_USERNAME: {
57                  fieldLength = buffer.readByte();
58                  username = buffer.readBytes(fieldLength).toString(CharsetUtil.US_ASCII);
59                  checkpoint(State.READ_PASSWORD);
60              }
61              case READ_PASSWORD: {
62                  fieldLength = buffer.readByte();
63                  password = buffer.readBytes(fieldLength).toString(CharsetUtil.US_ASCII);
64                  msg = new SocksAuthRequest(username, password);
65              }
66          }
67          ctx.getPipeline().remove(this);
68          return msg;
69      }
70  
71      enum State {
72          CHECK_PROTOCOL_VERSION,
73          READ_USERNAME,
74          READ_PASSWORD
75      }
76  }