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 SocksAuthResponse}.
25   * Before returning SocksResponse decoder removes itself from pipeline.
26   */
27  public class SocksAuthResponseDecoder extends ReplayingDecoder<SocksAuthResponseDecoder.State> {
28      private static final String name = "SOCKS_AUTH_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.SubnegotiationVersion version;
39      private SocksMessage.AuthStatus authStatus;
40      private SocksResponse msg = SocksCommonUtils.UNKNOWN_SOCKS_RESPONSE;
41  
42      public SocksAuthResponseDecoder() {
43          super(State.CHECK_PROTOCOL_VERSION);
44      }
45  
46      @Override
47      protected Object decode(ChannelHandlerContext ctx, Channel channel,
48                              ChannelBuffer buffer, State state) throws Exception {
49          switch (state) {
50              case CHECK_PROTOCOL_VERSION: {
51                  version = SocksMessage.SubnegotiationVersion.fromByte(buffer.readByte());
52                  if (version != SocksMessage.SubnegotiationVersion.AUTH_PASSWORD) {
53                      break;
54                  }
55                  checkpoint(State.READ_AUTH_RESPONSE);
56              }
57              case READ_AUTH_RESPONSE: {
58                  authStatus = SocksMessage.AuthStatus.fromByte(buffer.readByte());
59                  msg = new SocksAuthResponse(authStatus);
60              }
61          }
62          ctx.getPipeline().remove(this);
63          return msg;
64      }
65  
66      public enum State {
67          CHECK_PROTOCOL_VERSION,
68          READ_AUTH_RESPONSE
69      }
70  }