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    *   https://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.buffer.ByteBufUtil;
20  import io.netty.channel.ChannelHandlerContext;
21  import io.netty.handler.codec.ReplayingDecoder;
22  import io.netty.handler.codec.socks.SocksCmdRequestDecoder.State;
23  import io.netty.util.NetUtil;
24  import io.netty.util.internal.UnstableApi;
25  
26  import java.util.List;
27  
28  /**
29   * Decodes {@link ByteBuf}s into {@link SocksCmdRequest}.
30   * Before returning SocksRequest decoder removes itself from pipeline.
31   */
32  public class SocksCmdRequestDecoder extends ReplayingDecoder<State> {
33  
34      private SocksCmdType cmdType;
35      private SocksAddressType addressType;
36  
37      public SocksCmdRequestDecoder() {
38          super(State.CHECK_PROTOCOL_VERSION);
39      }
40  
41      @Override
42      protected void decode(ChannelHandlerContext ctx, ByteBuf byteBuf, List<Object> out) throws Exception {
43          switch (state()) {
44              case CHECK_PROTOCOL_VERSION: {
45                  if (byteBuf.readByte() != SocksProtocolVersion.SOCKS5.byteValue()) {
46                      out.add(SocksCommonUtils.UNKNOWN_SOCKS_REQUEST);
47                      break;
48                  }
49                  checkpoint(State.READ_CMD_HEADER);
50              }
51              case READ_CMD_HEADER: {
52                  cmdType = SocksCmdType.valueOf(byteBuf.readByte());
53                  byteBuf.skipBytes(1); // reserved
54                  addressType = SocksAddressType.valueOf(byteBuf.readByte());
55                  checkpoint(State.READ_CMD_ADDRESS);
56              }
57              case READ_CMD_ADDRESS: {
58                  switch (addressType) {
59                      case IPv4: {
60                          String host = NetUtil.intToIpAddress(ByteBufUtil.readIntBE(byteBuf));
61                          int port = ByteBufUtil.readUnsignedShortBE(byteBuf);
62                          out.add(new SocksCmdRequest(cmdType, addressType, host, port));
63                          break;
64                      }
65                      case DOMAIN: {
66                          int fieldLength = byteBuf.readByte();
67                          String host = SocksCommonUtils.readUsAscii(byteBuf, fieldLength);
68                          int port = ByteBufUtil.readUnsignedShortBE(byteBuf);
69                          out.add(new SocksCmdRequest(cmdType, addressType, host, port));
70                          break;
71                      }
72                      case IPv6: {
73                          byte[] bytes = new byte[16];
74                          byteBuf.readBytes(bytes);
75                          String host = SocksCommonUtils.ipv6toStr(bytes);
76                          int port = ByteBufUtil.readUnsignedShortBE(byteBuf);
77                          out.add(new SocksCmdRequest(cmdType, addressType, host, port));
78                          break;
79                      }
80                      case UNKNOWN: {
81                          out.add(SocksCommonUtils.UNKNOWN_SOCKS_REQUEST);
82                          break;
83                      }
84                      default: {
85                          throw new Error();
86                      }
87                  }
88                  break;
89              }
90              default: {
91                  throw new Error();
92              }
93          }
94          ctx.pipeline().remove(this);
95      }
96  
97      @UnstableApi
98      public enum State {
99          CHECK_PROTOCOL_VERSION,
100         READ_CMD_HEADER,
101         READ_CMD_ADDRESS
102     }
103 }