UnixSocket level option setter/getter helper. More...

#include <UnixOptions.hxx>

Inheritance diagram for cosmos::UnixOptions:

Public Member Functions
void	setPassCredentials (const bool on_off)
	This enables or disables the transfer of SCM_CREDENTIALS control messages.

void	setPassSecurity (const bool on_off)
	This enables or disables the reception of SCM_SECURITY ancillary messages.

UnixCredentials	credentials () const
	Returns the credentials of the peer process.

void	setPeekOffset (const bool on_off, const size_t offset=0)
	Sets an offset for the MessageFlag::PEEK receive() flag.

std::string	getPeerSec () const
	Returns the labeled IPSEC or NetLabel of the peer.

Protected Member Functions
	SockOptBase (FileDescriptor fd)
	Perform socket options on the given file descriptor.

	SockOptBase (const SockOptBase &)=delete

Protected Member Functions inherited from cosmos::SockOptBase< OptLevel::SOCKET >
	SockOptBase (FileDescriptor fd)
	Perform socket options on the given file descriptor.

	SockOptBase (const SockOptBase &)=delete

bool	getBoolOption (const OptName name) const
	Return a boolean style option.

void	setBoolOption (const OptName name, const bool val)
	Set a boolean style option.

int	getIntOption (const OptName name) const
	Return an integer option.

void	setIntOption (const OptName name, const int val)
	Set an integer option.

std::string	getStringOption (const OptName name, size_t max_len) const
	Return a null terminated string option.

void	setStringOption (const OptName name, const SysString str)
	Set a null terminated string option.

std::string	getPeerSec () const
	Returns the labeled IPSEC or NetLabel of the peer.

SockOptBase &	operator= (const SockOptBase &)=delete

Friends
class	UnixDatagramSocket

class	UnixConnection

class	UnixListenSocket

class	UnixClientSocket

Additional Inherited Members
Protected Attributes inherited from cosmos::SockOptBase< OptLevel::SOCKET >
FileDescriptor	m_sock
	The socket file descriptor to operate on.

Static Protected Attributes inherited from cosmos::SockOptBase< OptLevel::SOCKET >
static constexpr OptLevel	M_LEVEL
	The option level to operate on.

Detailed Description

UnixSocket level option setter/getter helper.

Definition at line 13 of file UnixOptions.hxx.

Member Function Documentation

◆ credentials()

UnixCredentials cosmos::UnixOptions::credentials ( ) const

Returns the credentials of the peer process.

This is used for UnixDomainSockets to identify the credentials of the peer process. These credentials are stored in the kernel during connect() or socketpair() of the related socket.

Definition at line 7 of file UnixOptions.cxx.

                                               {
        UnixCredentials ret;
        getsockopt(m_sock, M_LEVEL, OptName{SO_PEERCRED}, &ret, sizeof(ret));
        return ret;
}

◆ getPeerSec()

std::string cosmos::SockOptBase< LEVEL >::getPeerSec ( ) const

Returns the labeled IPSEC or NetLabel of the peer.

This only works if IPSEC or NetLabel is configured on both the sending and receiving hosts. This option is supported for TCP and SCTP sockets on IP level or for UNIX domain sockets.

The returned string will have the proper length and null termination. The encoding of the returned string is unspecified though. In particular it is not guaranteed to be ASCII or UTF-8.

Definition at line 50 of file SockOptBase.cxx.

                                               {
        std::string ret;
        ret.resize(cosmos::max::NAME);
 
        socklen_t length;
 
        while (true) {
                try {
                        length = getsockopt(m_sock, M_LEVEL, OptName{SO_PEERSEC}, ret.data(), ret.size());
 
                        if (ret[length-1] == '\0')
                                // it is not guaranteed that the string is
                                // null terminated, thus check this
                                length--;
 
                        ret.resize(length);
                        return ret;
                } catch (const RangeError &ex) {
                        if (!ex.requiredLengthKnown() || ex.requiredLength() < ret.size()) {
                                throw;
                        }
 
                        // retry with larger size
                        ret.resize(ret.size());
                }
        }
}

◆ setPassCredentials()

void cosmos::UnixOptions::setPassCredentials ( const bool on_off )

inline

This enables or disables the transfer of SCM_CREDENTIALS control messages.

If enabled then this message can be passed between processes that communicate via a UNIX domain socket. Note that both sides of the socket, the sender and the receiver need to enable this to work properly. Otherwise the message can be seen on the receiver side but with overflow values filled in for user and group ID and a ProcessID of 0.

Note that the ancillary message is not only provided to the receiving side if the sender explicitly sends the ancillary message, but also implicitly with each received message. The kernel fills in default values for the peer process (its PID and real user and group ID).

See also: credentials(); UnixCredentialsMessage

Definition at line 40 of file UnixOptions.hxx.

                                                   {
                setBoolOption(OptName{SO_PASSCRED}, on_off);
        }

◆ setPassSecurity()

void cosmos::UnixOptions::setPassSecurity ( const bool on_off )

inline

This enables or disables the reception of SCM_SECURITY ancillary messages.

This message contains the SELinux security label of the peer socket.

Definition at line 48 of file UnixOptions.hxx.

                                                {
                setBoolOption(OptName{SO_PASSSEC}, on_off);
        }

◆ setPeekOffset()

void cosmos::UnixOptions::setPeekOffset	(	const bool	on_off,
		const size_t	offset = 0 )

inline

Sets an offset for the MessageFlag::PEEK receive() flag.

If enabled then the recv() system call combined with MessageFlag::PEEK will cause data to be returned that is found at the given byte offset, instead of the beginning of the receive queue.

If data is removed from the input queue by doing a receive() without MessageFlag::PEEK then the offset will be decreased by the removed number of bytes, so that the offset is always pointing to the same relative position of the input queue.

Definition at line 71 of file UnixOptions.hxx.

                                                                       {
                const int off = on_off ? offset : -1;
                setIntOption(OptName{SO_PEEK_OFF}, off);
        }

◆ SockOptBase()

cosmos::SockOptBase< LEVEL >::SockOptBase ( FileDescriptor fd )

inlineexplicitprotected

Perform socket options on the given file descriptor.

Definition at line 22 of file SockOptBase.hxx.

22 :

23 m_sock{fd} {}

Friends And Related Symbol Documentation

◆ UnixClientSocket

friend class UnixClientSocket

friend

Definition at line 19 of file UnixOptions.hxx.

◆ UnixConnection

friend class UnixConnection

friend

Definition at line 17 of file UnixOptions.hxx.

◆ UnixDatagramSocket

friend class UnixDatagramSocket

friend

Definition at line 16 of file UnixOptions.hxx.

◆ UnixListenSocket

friend class UnixListenSocket

friend

Definition at line 18 of file UnixOptions.hxx.

The documentation for this class was generated from the following files:

include/net/UnixOptions.hxx
src/net/UnixOptions.cxx

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ credentials()

◆ getPeerSec()

◆ setPassCredentials()

◆ setPassSecurity()

◆ setPeekOffset()

◆ SockOptBase()

Friends And Related Symbol Documentation

◆ UnixClientSocket

◆ UnixConnection

◆ UnixDatagramSocket

◆ UnixListenSocket