View Javadoc
1   /*
2    * Copyright 2023 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.quic;
17  
18  import java.nio.ByteBuffer;
19  
20  /**
21   * Generate
22   * <a href="https://www.ietf.org/archive/id/draft-ietf-quic-transport-29.html#name-calculating-a-stateless-res">
23   *     stateless reset tokens</a> to use.
24   */
25  public interface QuicResetTokenGenerator {
26  
27      /**
28       * Generate a reset token to use for the given connection id. The returned token MUST be of length 16.
29       * @param cid the connection id
30       * @return a newly generated reset token
31       */
32      ByteBuffer newResetToken(ByteBuffer cid);
33  
34      /**
35       * Return a {@link QuicResetTokenGenerator} which generates new reset tokens by signing the given input.
36       *
37       * @return a {@link QuicResetTokenGenerator} which generates new reset tokens by signing the given input.
38       */
39      static QuicResetTokenGenerator signGenerator() {
40          return HmacSignQuicResetTokenGenerator.INSTANCE;
41      }
42  }