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.channel.ChannelHandlerContext;
20  import io.netty.handler.codec.ReplayingDecoder;
21  import io.netty.handler.codec.socks.SocksAuthRequestDecoder.State;
22  import io.netty.util.CharsetUtil;
23  import io.netty.util.internal.UnstableApi;
24  
25  import java.util.List;
26  
27  /**
28   * Decodes {@link ByteBuf}s into {@link SocksAuthRequest}.
29   * Before returning SocksRequest decoder removes itself from pipeline.
30   */
31  public class SocksAuthRequestDecoder extends ReplayingDecoder<State> {
32  
33      private String username;
34  
35      public SocksAuthRequestDecoder() {
36          super(State.CHECK_PROTOCOL_VERSION);
37      }
38  
39      @Override
40      protected void decode(ChannelHandlerContext ctx, ByteBuf byteBuf, List<Object> out) throws Exception {
41          switch (state()) {
42              case CHECK_PROTOCOL_VERSION: {
43                  if (byteBuf.readByte() != SocksSubnegotiationVersion.AUTH_PASSWORD.byteValue()) {
44                      out.add(SocksCommonUtils.UNKNOWN_SOCKS_REQUEST);
45                      break;
46                  }
47                  checkpoint(State.READ_USERNAME);
48              }
49              case READ_USERNAME: {
50                  int fieldLength = byteBuf.readByte();
51                  username = byteBuf.readString(fieldLength, CharsetUtil.US_ASCII);
52                  checkpoint(State.READ_PASSWORD);
53              }
54              case READ_PASSWORD: {
55                  int fieldLength = byteBuf.readByte();
56                  String password = byteBuf.readString(fieldLength, CharsetUtil.US_ASCII);
57                  out.add(new SocksAuthRequest(username, password));
58                  break;
59              }
60              default: {
61                  throw new Error();
62              }
63          }
64          ctx.pipeline().remove(this);
65      }
66  
67      @UnstableApi
68      public enum State {
69          CHECK_PROTOCOL_VERSION,
70          READ_USERNAME,
71          READ_PASSWORD
72      }
73  }