From 9448e26fcd7602098b4bf9cd7fe535136e89e10b Mon Sep 17 00:00:00 2001 From: Maria Sharabayko Date: Fri, 2 Jun 2023 16:25:41 +0200 Subject: [PATCH] [docs] Minor updates to AEAD docs plus changed v1.6.0 to 1.5.2 in some files --- docs/API/API-functions.md | 2 +- docs/API/API-socket-options.md | 4 ++-- docs/build/build-options.md | 3 ++- srtcore/srt.h | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/API/API-functions.md b/docs/API/API-functions.md index 4292a99b5..042ece34c 100644 --- a/docs/API/API-functions.md +++ b/docs/API/API-functions.md @@ -171,7 +171,7 @@ Since SRT v1.5.0. | [SRT_REJ_FILTER](#SRT_REJ_FILTER) | 1.3.4 | The [`SRTO_PACKETFILTER`](API-socket-options.md#SRTO_PACKETFILTER) option has been set differently on both connection parties | | [SRT_REJ_GROUP](#SRT_REJ_GROUP) | 1.4.2 | The group type or some group settings are incompatible for both connection parties | | [SRT_REJ_TIMEOUT](#SRT_REJ_TIMEOUT) | 1.4.2 | The connection wasn't rejected, but it timed out | -| [SRT_REJ_CRYPTO](#SRT_REJ_CRYPTO) | 1.6.0-dev | The connection was rejected due to an unsupported or mismatching encryption mode | +| [SRT_REJ_CRYPTO](#SRT_REJ_CRYPTO) | 1.5.2 | The connection was rejected due to an unsupported or mismatching encryption mode | | | | |

Error Codes

diff --git a/docs/API/API-socket-options.md b/docs/API/API-socket-options.md index 5d32db4ca..10e732b0b 100644 --- a/docs/API/API-socket-options.md +++ b/docs/API/API-socket-options.md @@ -204,7 +204,7 @@ The following table lists SRT API socket options in alphabetical order. Option d | [`SRTO_BINDTODEVICE`](#SRTO_BINDTODEVICE) | 1.4.2 | pre-bind | `string` | | | | RW | GSD+ | | [`SRTO_CONGESTION`](#SRTO_CONGESTION) | 1.3.0 | pre | `string` | | "live" | \* | W | S | | [`SRTO_CONNTIMEO`](#SRTO_CONNTIMEO) | 1.1.2 | pre | `int32_t` | ms | 3000 | 0.. | W | GSD+ | -| [`SRTO_CRYPTOMODE`](#SRTO_CRYPTOMODE) | 1.6.0-dev | pre | `int32_t` | | 0 (Auto) | [0, 2] | W | GSD | +| [`SRTO_CRYPTOMODE`](#SRTO_CRYPTOMODE) | 1.5.2 | pre | `int32_t` | | 0 (Auto) | [0, 2] | W | GSD | | [`SRTO_DRIFTTRACER`](#SRTO_DRIFTTRACER) | 1.4.2 | post | `bool` | | true | | RW | GSD | | [`SRTO_ENFORCEDENCRYPTION`](#SRTO_ENFORCEDENCRYPTION) | 1.3.2 | pre | `bool` | | true | | W | GSD | | [`SRTO_EVENT`](#SRTO_EVENT) | | | `int32_t` | flags | | | R | S | @@ -327,7 +327,7 @@ will be 10 times the value set with `SRTO_CONNTIMEO`. | OptName | Since | Restrict | Type | Units | Default | Range | Dir | Entity | | ------------------ | --------- | -------- | --------- | ------ | -------- | ------ | --- | ------ | -| `SRTO_CRYPTOMODE` | 1.6.0-dev | pre | `int32_t` | | 0 (Auto) | [0, 2] | RW | GSD | +| `SRTO_CRYPTOMODE` | 1.5.2 | pre | `int32_t` | | 0 (Auto) | [0, 2] | RW | GSD | The encryption mode to be used if the [`SRTO_PASSPHRASE`](#SRTO_PASSPHRASE) is set. diff --git a/docs/build/build-options.md b/docs/build/build-options.md index a2fcd20cd..25ef1f7d3 100644 --- a/docs/build/build-options.md +++ b/docs/build/build-options.md @@ -275,7 +275,8 @@ use encryption for the connection. When ON, the AEAD API is enabled. The `ENABLE_ENCRYPTION` must be enabled as well. The AEAD functionality is only available if OpenSSL EVP is selected as the crypto provider: -build option `-DUSE_ENCLIB=openssl-evp`. +build option should be set to `USE_ENCLIB=openssl-evp`. + The AEAD API is to be official in SRT v1.6.0. diff --git a/srtcore/srt.h b/srtcore/srt.h index 39a90ce71..c30169f05 100644 --- a/srtcore/srt.h +++ b/srtcore/srt.h @@ -646,7 +646,7 @@ enum SRT_KM_STATE SRT_KM_S_NOSECRET = 3, // Stream encrypted and no secret to decrypt Keying Material SRT_KM_S_BADSECRET = 4 // Stream encrypted and wrong secret is used, cannot decrypt Keying Material #ifdef ENABLE_AEAD_API_PREVIEW - ,SRT_KM_S_BADCRYPTOMODE = 5 // Stream encrypted but wrong cryptographic mode is used, cannot decrypt. Since v1.6.0. + ,SRT_KM_S_BADCRYPTOMODE = 5 // Stream encrypted but wrong cryptographic mode is used, cannot decrypt. Since v1.5.2. #endif };