View Javadoc
1   /*
2    * Copyright 2014 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  
17  package io.netty.handler.codec.socksx.v4;
18  
19  import io.netty.buffer.ByteBuf;
20  import io.netty.buffer.ByteBufUtil;
21  import io.netty.channel.ChannelHandler.Sharable;
22  import io.netty.channel.ChannelHandlerContext;
23  import io.netty.handler.codec.EncoderException;
24  import io.netty.handler.codec.MessageToByteEncoder;
25  import io.netty.util.AsciiString;
26  import io.netty.util.NetUtil;
27  
28  /**
29   * Encodes a {@link Socks4CommandRequest} into a {@link ByteBuf}.
30   */
31  @Sharable
32  public final class Socks4ClientEncoder extends MessageToByteEncoder<Socks4CommandRequest> {
33  
34      /**
35       * The singleton instance of {@link Socks4ClientEncoder}
36       */
37      public static final Socks4ClientEncoder INSTANCE = new Socks4ClientEncoder();
38  
39      private static final byte[] IPv4_DOMAIN_MARKER = {0x00, 0x00, 0x00, 0x01};
40  
41      private Socks4ClientEncoder() {
42          super(Socks4CommandRequest.class);
43      }
44  
45      @Override
46      protected void encode(ChannelHandlerContext ctx, Socks4CommandRequest msg, ByteBuf out) throws Exception {
47          out.writeByte(msg.version().byteValue());
48          out.writeByte(msg.type().byteValue());
49          ByteBufUtil.writeShortBE(out, msg.dstPort());
50          if (NetUtil.isValidIpV4Address(msg.dstAddr())) {
51              out.writeBytes(NetUtil.createByteArrayFromIpAddressString(msg.dstAddr()));
52              ByteBufUtil.writeAscii(out, sanitize("userId", msg.userId()));
53              out.writeByte(0);
54          } else {
55              out.writeBytes(IPv4_DOMAIN_MARKER);
56              ByteBufUtil.writeAscii(out, sanitize("userId", msg.userId()));
57              out.writeByte(0);
58              ByteBufUtil.writeAscii(out, sanitize("dstAddr", msg.dstAddr()));
59              out.writeByte(0);
60          }
61      }
62  
63      private CharSequence sanitize(String fieldName, String strValue) {
64          for (int i = 0, len = strValue.length(); i < len; i++) {
65              char c = strValue.charAt(i);
66              // SOCKS4 uses NUL-bytes as field delimiters.
67              if (AsciiString.c2b(c) == 0) {
68                  throw new EncoderException("Illegal character in " + fieldName + " field.");
69              }
70          }
71          return strValue;
72      }
73  }