Thread-safe authenticated encryption with symmetric, asymmetric, and pluggable modes. 更多...

#include <security.h>

vlink::Security 的协作图:

类
struct	Config
	Aggregate of every parameter accepted by the `Security` constructor. 更多...

Public 类型
using	Callback = Function< bool(const Bytes &in, Bytes &out)>
	Callable signature for user-supplied encrypt / decrypt callbacks. 更多...

Public 成员函数
	Security ()
	Constructs an empty `Security`; equivalent to `Security`(Config{}). 更多...

	Security (const Config &cfg)
	Constructs from a configuration aggregate, copying caller state. 更多...

	Security (Config &&cfg)
	Constructs from a configuration aggregate, moving caller state in. 更多...

	~Security ()
	Destroys the instance and zeroises any held symmetric key material in place. 更多...

	Security (Security &&) noexcept
	Move-constructs from another `Security`; the source becomes default-constructed. 更多...

Security &	operator= (Security &&) noexcept
	Move-assigns from another `Security`; the source becomes default-constructed. 更多...

bool	encrypt (const Bytes &in, Bytes &out)
	Encrypts `in` into `out` using the highest-precedence active mode. 更多...

bool	decrypt (const Bytes &in, Bytes &out)
	Decrypts `in` into `out` using the highest-precedence active mode. 更多...

bool	is_configured () const noexcept
	Reports whether at least one usable cryptographic slot is installed. 更多...

bool	can_encrypt () const noexcept
	Reports whether `encrypt()` will succeed. 更多...

bool	can_decrypt () const noexcept
	Reports whether `decrypt()` will succeed. 更多...

静态 Public 成员函数
static Config	from_private_key_path (const std::string &private_key_path)
	Loads a private-key PEM file into a fresh `Config`. 更多...

static Config	from_public_key_path (const std::string &public_key_path)
	Loads a public-key PEM file into a fresh `Config`. 更多...

static Config	from_key_paths (const std::string &public_key_path, const std::string &private_key_path)
	Loads both a public-key and a private-key PEM file into a fresh `Config`. 更多...

详细描述

Thread-safe authenticated encryption with symmetric, asymmetric, and pluggable modes.

One Security instance per endpoint. Configuration is supplied through Config at construction time; copy and assignment are deleted, move is supported. Each call to encrypt() / decrypt() selects a mode using the precedence order described in the file-level mode summary diagram.

成员类型定义说明

◆ Callback

using vlink::Security::Callback = Function<bool(const Bytes& in, Bytes& out)>

Callable signature for user-supplied encrypt / decrypt callbacks.

Implementations must populate out and return true on success; failure leaves out empty and the surrounding encrypt() / decrypt() call returns false. Function is copyable, so callbacks may be passed in a const-reference Config.

构造及析构函数说明

◆ Security() [1/4]

vlink::Security::Security ( )

Constructs an empty Security; equivalent to Security(Config{}).

With built-in algorithms compiled in, this installs the default symmetric slot; otherwise the instance reports is_configured() == false and refuses to encrypt or decrypt.

◆ Security() [2/4]

vlink::Security::Security ( const Config & cfg )

explicit

Constructs from a configuration aggregate, copying caller state.

参数

cfg	Configuration aggregate; every non-empty field is validated and installed.

◆ Security() [3/4]

vlink::Security::Security ( Config && cfg )

explicit

Constructs from a configuration aggregate, moving caller state in.

参数

cfg	Configuration aggregate consumed during construction.

◆ ~Security()

vlink::Security::~Security ( )

Destroys the instance and zeroises any held symmetric key material in place.

◆ Security() [4/4]

vlink::Security::Security ( Security && )

noexcept

Move-constructs from another Security; the source becomes default-constructed.

成员函数说明

◆ can_decrypt()

bool vlink::Security::can_decrypt ( ) const

noexcept

Reports whether decrypt() will succeed.

Requires at least one of: a custom callback pair, a derived AES-128 key, or a local private_key_pem. A bare public_key_pem alone is insufficient.

返回: true when a decryption capability is installed.

◆ can_encrypt()

bool vlink::Security::can_encrypt ( ) const

noexcept

Reports whether encrypt() will succeed.

Requires at least one of: a custom callback pair, a derived AES-128 key, or a peer public_key_pem. A bare private_key_pem alone is insufficient.

返回: true when an encryption capability is installed.

◆ decrypt()

bool vlink::Security::decrypt	(	const Bytes &	in,
		Bytes &	out
	)

Decrypts in into out using the highest-precedence active mode.

Mode selection mirrors encrypt() but uses the inbound direction (custom > asymmetric private key > symmetric). Tampered ciphertext, mismatched AAD, replayed sequence numbers, and missing or invalid RSA-PSS signatures (when verify_key_pem is set) cause failure.

参数

in	Ciphertext produced by a peer's `encrypt()`.
out	Output buffer overwritten on success and emptied on failure.

返回: true on success; false otherwise.

◆ encrypt()

bool vlink::Security::encrypt	(	const Bytes &	in,
		Bytes &	out
	)

Encrypts in into out using the highest-precedence active mode.

The selected mode follows the precedence summarised in the file-level diagram: custom > asymmetric (public key present) > symmetric. Empty in fails; AEAD requires at least one byte of authenticated material. Inputs exceeding INT_MAX bytes are rejected.

参数

in	Plaintext payload.
out	Output buffer overwritten on success and emptied on failure.

返回: true on success; false otherwise.

◆ from_key_paths()

static Config vlink::Security::from_key_paths	(	const std::string &	public_key_path,
		const std::string &	private_key_path
	)

static

Loads both a public-key and a private-key PEM file into a fresh Config.

参数

public_key_path	Filesystem path of the PEM-encoded peer public key.
private_key_path	Filesystem path of the PEM-encoded local private key.

返回: Pre-populated Config; per-file misses leave only the affected field empty.

◆ from_private_key_path()

static Config vlink::Security::from_private_key_path ( const std::string & private_key_path )

static

Loads a private-key PEM file into a fresh Config.

Reads the file at construction time and populates Config::private_key_pem. RSA validation is deferred until the Security constructor consumes the config.

参数

private_key_path Filesystem path of the PEM-encoded private key.

返回: Pre-populated Config; private_key_pem is empty when the file is unreadable.

◆ from_public_key_path()

static Config vlink::Security::from_public_key_path ( const std::string & public_key_path )

static

Loads a public-key PEM file into a fresh Config.

参数

public_key_path Filesystem path of the PEM-encoded public key.

返回: Pre-populated Config; public_key_pem is empty when the file is unreadable.

◆ is_configured()

bool vlink::Security::is_configured ( ) const

noexcept

Reports whether at least one usable cryptographic slot is installed.

A true result merely means the instance can call encrypt() or decrypt() in some direction; senders should additionally verify can_encrypt() and receivers can_decrypt() to catch direction-specific RSA misconfiguration.

返回: true when any slot is usable in either direction.

◆ operator=()

Security& vlink::Security::operator= ( Security && )

noexcept

Move-assigns from another Security; the source becomes default-constructed.

该类的文档由以下文件生成:

include/vlink/extension/security.h

类

Public 类型

Public 成员函数

静态 Public 成员函数

详细描述

成员类型定义说明

◆ Callback

构造及析构函数说明

◆ Security() [1/4]

◆ Security() [2/4]

◆ Security() [3/4]

◆ ~Security()

◆ Security() [4/4]

成员函数说明

◆ can_decrypt()

◆ can_encrypt()

◆ decrypt()

◆ encrypt()

◆ from_key_paths()

◆ from_private_key_path()

◆ from_public_key_path()

◆ is_configured()

◆ operator=()