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 io.netty.handler.codec.socks;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.channel.ChannelHandlerContext;
20  import io.netty.handler.codec.ReplayingDecoder;
21  import io.netty.handler.codec.socks.SocksInitRequestDecoder.State;
22  
23  import java.util.ArrayList;
24  import java.util.Collections;
25  import java.util.List;
26  
27  /**
28   * Decodes {@link ByteBuf}s into {@link SocksInitRequest}.
29   * Before returning SocksRequest decoder removes itself from pipeline.
30   */
31  public class SocksInitRequestDecoder extends ReplayingDecoder<State> {
32      private static final String name = "SOCKS_INIT_REQUEST_DECODER";
33  
34      /**
35       * @deprecated Will be removed at the next minor version bump.
36       */
37      @Deprecated
38      public static String getName() {
39          return name;
40      }
41  
42      public SocksInitRequestDecoder() {
43          super(State.CHECK_PROTOCOL_VERSION);
44      }
45  
46      @Override
47      protected void decode(ChannelHandlerContext ctx, ByteBuf byteBuf, List<Object> out) throws Exception {
48          switch (state()) {
49              case CHECK_PROTOCOL_VERSION: {
50                  if (byteBuf.readByte() != SocksProtocolVersion.SOCKS5.byteValue()) {
51                      out.add(SocksCommonUtils.UNKNOWN_SOCKS_REQUEST);
52                      break;
53                  }
54                  checkpoint(State.READ_AUTH_SCHEMES);
55              }
56              case READ_AUTH_SCHEMES: {
57                  final byte authSchemeNum = byteBuf.readByte();
58                  final List<SocksAuthScheme> authSchemes;
59                  if (authSchemeNum > 0) {
60                      authSchemes = new ArrayList<SocksAuthScheme>(authSchemeNum);
61                      for (int i = 0; i < authSchemeNum; i++) {
62                          authSchemes.add(SocksAuthScheme.valueOf(byteBuf.readByte()));
63                      }
64                  } else {
65                      authSchemes = Collections.emptyList();
66                  }
67                  out.add(new SocksInitRequest(authSchemes));
68                  break;
69              }
70              default: {
71                  throw new Error();
72              }
73          }
74          ctx.pipeline().remove(this);
75      }
76  
77      enum State {
78          CHECK_PROTOCOL_VERSION,
79          READ_AUTH_SCHEMES
80      }
81  }