1 /*
2 * Copyright 2025 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.socksx.v5;
17
18 /**
19 * A SOCKS5 subnegotiation request for private authentication.
20 * <p>
21 * RFC 1928 reserves method codes 0x80-0xFE for private authentication methods.
22 * This interface provides a base implementation for method 0x80, but can be extended
23 * for other private authentication methods by implementing custom encoders/decoders.
24 * </p>
25 *
26 * @see <a href="https://www.ietf.org/rfc/rfc1928.txt">RFC 1928 Section 3</a>
27 */
28 public interface Socks5PrivateAuthRequest extends Socks5Message {
29
30 /**
31 * Returns the private token of this request.
32 * <p>
33 * For custom subnegotiation protocols, this could be extended by adding
34 * additional methods in a subinterface.
35 * </p>
36 *
37 * @return the private authentication token
38 */
39 byte[] privateToken();
40 }