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  
23  /**
24   * Decodes {@link ChannelBuffer}s into {@link SocksInitResponse}.
25   * Before returning SocksResponse decoder removes itself from pipeline.
26   */
27  public class SocksInitResponseDecoder extends ReplayingDecoder<SocksInitResponseDecoder.State> {
28      private static final String name = "SOCKS_INIT_RESPONSE_DECODER";
29  
30      /**
31       * @deprecated Will be removed at the next minor version bump.
32       */
33      @Deprecated
34      public static String getName() {
35          return name;
36      }
37  
38      private SocksMessage.ProtocolVersion version;
39      private SocksMessage.AuthScheme authScheme;
40  
41      private SocksResponse msg = SocksCommonUtils.UNKNOWN_SOCKS_RESPONSE;
42  
43      public SocksInitResponseDecoder() {
44          super(State.CHECK_PROTOCOL_VERSION);
45      }
46  
47      @Override
48      protected Object decode(ChannelHandlerContext ctx, Channel channel,
49                              ChannelBuffer buffer, State state) throws Exception {
50          switch (state) {
51              case CHECK_PROTOCOL_VERSION: {
52                  version = SocksMessage.ProtocolVersion.fromByte(buffer.readByte());
53                  if (version != SocksMessage.ProtocolVersion.SOCKS5) {
54                      break;
55                  }
56                  checkpoint(State.READ_PREFFERED_AUTH_TYPE);
57              }
58              case READ_PREFFERED_AUTH_TYPE: {
59                  authScheme = SocksMessage.AuthScheme.fromByte(buffer.readByte());
60                  msg = new SocksInitResponse(authScheme);
61                  break;
62              }
63          }
64          ctx.getPipeline().remove(this);
65          return msg;
66      }
67  
68      public enum State {
69          CHECK_PROTOCOL_VERSION,
70          READ_PREFFERED_AUTH_TYPE
71      }
72  }