/* * Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package jdk.internal.net.quic; import sun.security.ssl.Alert; import java.util.Optional; import java.util.stream.Stream; /** * An enum to model Quic transport errors. * Some errors have a single possible code value, some, like * {@link #CRYPTO_ERROR} have a range of possible values. * Usually, the value (a long) would be used instead of the * enum, but the enum itself can be useful - for instance in * switch statements. * This enum models QUIC transport error codes as defined in * RFC 9000, section 20.1. */ public enum QuicTransportErrors { /** * No error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint uses this with CONNECTION_CLOSE to signal that
     * the connection is being closed abruptly in the absence
     * of any error.
     * }

*/ NO_ERROR(0x00), /** * Internal Error. *

* From * RFC 9000, Section 20.1: *

{@code
     * The endpoint encountered an internal error and cannot
     * continue with the connection.
     * }

*/ INTERNAL_ERROR(0x01), /** * Connection refused error. *

* From * RFC 9000, Section 20.1: *

{@code
     * The server refused to accept a new connection.
     * }

*/ CONNECTION_REFUSED(0x02), /** * Flow control error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint received more data than it permitted in its advertised data limits;
     * see Section 4.
     * }

* @see * RFC 9000, Section 20.1: *

{@code
     * An endpoint received a frame for a stream identifier that exceeded its advertised
     * stream limit for the corresponding stream type.
     * }

*/ STREAM_LIMIT_ERROR(0x04), /** * Stream state error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint received a frame for a stream that was not in a state that permitted
     * that frame; see Section 3.
     * }

* @see * RFC 9000, Section 20.1: *

{@code
     * (1) An endpoint received a STREAM frame containing data that exceeded the previously
     *     established final size,
     * (2) an endpoint received a STREAM frame or a RESET_STREAM frame containing a final
     *     size that was lower than the size of stream data that was already received, or
     * (3) an endpoint received a STREAM frame or a RESET_STREAM frame containing a
     *     different final size to the one already established.
     * }

*/ FINAL_SIZE_ERROR(0x06), /** * Frame encoding error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint received a frame that was badly formatted -- for instance,
     * a frame of an unknown type or an ACK frame that has more
     * acknowledgment ranges than the remainder of the packet could carry.
     * }

*/ FRAME_ENCODING_ERROR(0x07), /** * Transport parameter error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint received transport parameters that were badly
     * formatted, included an invalid value, omitted a mandatory
     * transport parameter, included a forbidden transport
     * parameter, or were otherwise in error.
     * }

*/ TRANSPORT_PARAMETER_ERROR(0x08), /** * Connection id limit error. *

* From * RFC 9000, Section 20.1: *

{@code
     * The number of connection IDs provided by the peer exceeds
     * the advertised active_connection_id_limit.
     * }

*/ CONNECTION_ID_LIMIT_ERROR(0x09), /** * Protocol violiation error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint detected an error with protocol compliance that
     * was not covered by more specific error codes.
     * }

*/ PROTOCOL_VIOLATION(0x0a), /** * Invalid token error. *

* From * RFC 9000, Section 20.1: *

{@code
     * A server received a client Initial that contained an invalid Token field.
     * }

*/ INVALID_TOKEN(0x0b), /** * Application error. *

* From * RFC 9000, Section 20.1: *

{@code
     * The application or application protocol caused the connection to be closed.
     * }

*/ APPLICATION_ERROR(0x0c), /** * Crypto buffer exceeded error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint has received more data in CRYPTO frames than it can buffer.
     * }

*/ CRYPTO_BUFFER_EXCEEDED(0x0d), /** * Key update error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint detected errors in performing key updates; see Section 6 of [QUIC-TLS].
     * }

* @see Section 6 of RFC 9001 [QUIC-TLS] */ KEY_UPDATE_ERROR(0x0e), /** * AEAD limit reached error *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint has reached the confidentiality or integrity limit
     * for the AEAD algorithm used by the given connection.
     * }

*/ AEAD_LIMIT_REACHED(0x0f), /** * No viable path error. *

* From * RFC 9000, Section 20.1: *

{@code
     * An endpoint has determined that the network path is incapable of
     * supporting QUIC. An endpoint is unlikely to receive a
     * CONNECTION_CLOSE frame carrying this code except when the
     * path does not support a large enough MTU.
     * }

*/ NO_VIABLE_PATH(0x10), /** * Error negotiating version. * @spec https://www.rfc-editor.org/rfc/rfc9368#name-version-downgrade-preventio * RFC 9368, Section 4 */ VERSION_NEGOTIATION_ERROR(0x11), /** * Crypto error. *

* From * RFC 9000, Section 20.1: *

{@code
     * The cryptographic handshake failed. A range of 256 values is
     * reserved for carrying error codes specific to the cryptographic
     * handshake that is used. Codes for errors occurring when
     * TLS is used for the cryptographic handshake are described
     * in Section 4.8 of [QUIC-TLS].
     * }

* @see Section 4.8 of RFC 9001 [QUIC-TLS] */ CRYPTO_ERROR(0x0100, 0x01ff); private final long from; private final long to; QuicTransportErrors(long code) { this(code, code); } QuicTransportErrors(long from, long to) { assert from <= to; this.from = from; this.to = to; } /** * {@return the code for this transport error, if this error * {@linkplain #hasCode() has a single possible code value}, * {@code -1} otherwise} */ public long code() { return hasCode() ? from : -1;} /** * {@return true if this error has a single possible code value} */ public boolean hasCode() { return from == to; } /** * {@return true if this error has a range of possible code values} */ public boolean hasRange() { return from < to;} /** * {@return the first possible code value in the range, or the * code value if this error has a single possible code value} */ public long from() {return from;} /** * {@return the last possible code value in the range, or the * code value if this error has a single possible code value} */ public long to() { return to; } /** * Tells whether the given {@code code} value corresponds to * this error. * @param code an error code value * @return true if the given {@code code} value corresponds to * this error. */ boolean isFor(long code) { return code >= from && code <= to; } /** * {@return the {@link QuicTransportErrors} instance corresponding * to the given {@code code} value, if any} * @param code a {@code code} value */ public static Optional ofCode(long code) { return Stream.of(values()).filter(e -> e.isFor(code)).findAny(); } public static String toString(long code) { Optional c = Stream.of(values()).filter(e -> e.isFor(code)).findAny(); if (c.isEmpty()) return "Unknown [0x"+Long.toHexString(code) + "]"; if (c.get().hasCode()) return c.get().toString(); if (c.get() == CRYPTO_ERROR) return c.get() + "|" + Alert.nameOf((byte)code); return c.get() + " [0x" + Long.toHexString(code) + "]"; } }