extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2024-12-14 02:41:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update tls doc

Browse Source
This commit is contained in:
Zoltán Papp 2024-12-07 10:15:05 +01:00
parent 57f54fb18c
commit e147c1b1a1
1 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
relay/tls/doc.go
View File

@ -1,37 +1,36 @@
// Package tls provides utilities for configuring and managing // Package tls provides utilities for configuring and managing Transport Layer
// Transport Layer Security (TLS) in server environments, with // Security (TLS) in server and client environments, with a focus on QUIC
// a focus on QUIC protocol support and testing configurations. // protocol support and testing configurations.
// //
// The package includes functions for cloning and customizing // The package includes functions for cloning and customizing TLS
// TLS configurations as well as generating self-signed // configurations as well as generating self-signed certificates for
// certificates for development and testing purposes. // development and testing purposes.
// //
// Key Features: // Key Features:
// //
// - `ServerQUICTLSConfig`: Creates a server-side TLS configuration // - `ServerQUICTLSConfig`: Creates a server-side TLS configuration tailored
// tailored for QUIC protocol with specified or default settings. // for QUIC protocol with specified or default settings. QUIC requires a
// QUIC requires a specific TLS configuration with proper ALPN // specific TLS configuration with proper ALPN (Application-Layer Protocol
// (Application-Layer Protocol Negotiation) support, making the // Negotiation) support, making the TLS settings crucial for establishing
// TLS settings crucial for establishing secure connections. // secure connections.
// //
// - `ClientQUICTLSConfig`: Provides a client-side TLS configuration // - `ClientQUICTLSConfig`: Provides a client-side TLS configuration suitable
// suitable for QUIC protocol. The configuration differs between // for QUIC protocol. The configuration differs between development
// development (insecure testing) and production (strict verification). // (insecure testing) and production (strict verification).
// //
// - `generateTestTLSConfig`: Generates a self-signed TLS configuration // - `generateTestTLSConfig`: Generates a self-signed TLS configuration for
// for use in local development and testing scenarios. // use in local development and testing scenarios.
// //
// Usage: // Usage:
// //
// This package provides separate implementations for development // This package provides separate implementations for development and production
// and production environments. The development implementation // environments. The development implementation (guarded by `//go:build devcert`)
// (guarded by `//go:build dev`) supports testing configurations // supports testing configurations with self-signed certificates and insecure
// with self-signed certificates and insecure client connections. // client connections. The production implementation (guarded by `//go:build
// The production implementation (guarded by `//go:build !dev`) // !devcert`) ensures that valid and secure TLS configurations are supplied
// ensures that valid and secure TLS configurations are supplied
// and used. // and used.
// //
// The QUIC protocol is highly reliant on properly configured TLS // The QUIC protocol is highly reliant on properly configured TLS settings,
// settings, and this package ensures that configurations meet the // and this package ensures that configurations meet the requirements for
// requirements for secure and efficient QUIC communication. // secure and efficient QUIC communication.
package tls package tls