@seydx/rtsp / RtspAuthConfig

Interface: RtspAuthConfig

Defined in: sinks/rtsp-server/auth.ts:10

Credentials and scheme configuration for RTSP server authentication.

Describes the single account that an RtspServerSink will require clients to authenticate against, along with the authentication scheme to advertise and the protection realm presented in the challenge.

Properties

method?

optional method?: "Basic" | "Digest"

Defined in: sinks/rtsp-server/auth.ts:34

The authentication scheme to advertise and enforce.

Digest performs a challenge-response exchange and never transmits the password over the wire, while Basic sends base64-encoded credentials and should only be used over a secured transport. Defaults to Digest.

---

password

password: string

Defined in: sinks/rtsp-server/auth.ts:25

The secret associated with RtspAuthConfig.username.

Used to build the expected Basic credential or the Digest HA1 hash. Stored as provided; it is never sent to the client.

---

realm?

optional realm?: string

Defined in: sinks/rtsp-server/auth.ts:42

The protection realm presented in the authentication challenge.

Surfaced to clients in the WWW-Authenticate header and, for Digest, mixed into the HA1 hash. Defaults to seydx-rtsp.

---

username

username: string

Defined in: sinks/rtsp-server/auth.ts:17

The account name a client must present.

Compared verbatim against the username supplied by the client (the Basic credential pair or the Digest username parameter).