Package io.netty.handler.codec.socksx.v5

Interface Socks5PrivateAuthRequest

  • All Superinterfaces:
    io.netty.handler.codec.DecoderResultProvider, Socks5Message, SocksMessage
    All Known Implementing Classes:
    DefaultSocks5PrivateAuthRequest
    public interface Socks5PrivateAuthRequest
extends Socks5Message
    A SOCKS5 subnegotiation request for private authentication.

    RFC 1928 reserves method codes 0x80-0xFE for private authentication methods. This interface provides a base implementation for method 0x80, but can be extended for other private authentication methods by implementing custom encoders/decoders.

    See Also:
    RFC 1928 Section 3

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] privateToken()
      Returns the private token of this request.

      • Methods inherited from interface io.netty.handler.codec.DecoderResultProvider

        decoderResult, setDecoderResult

    • Method Detail

      • privateToken

        byte[] privateToken()
        Returns the private token of this request.

        For custom subnegotiation protocols, this could be extended by adding additional methods in a subinterface.

        Returns:
        the private authentication token