cosmos::UnixCredentialsMessage Class Reference

Wrapper for the SCM_CREDENTIALS socket ancillary message to transfer process credentials between processes. More...

#include <unix_aux.hxx>

Inheritance diagram for cosmos::UnixCredentialsMessage:

Public Member Functions
void	deserialize (const ReceiveMessageHeader::ControlMessage &msg)
SendMessageHeader::ControlMessage	serialize () const
void	setCreds (const UnixCredentials &creds)
const UnixCredentials &	creds () const

Protected Attributes
UnixCredentials	m_creds

Additional Inherited Members
Protected Member Functions inherited from cosmos::AncillaryMessage< OptLevel::SOCKET, UnixMessage >
SendMessageHeader::ControlMessage	createMsg (UnixMessage type, const size_t data_len) const
void	checkMsg (const ReceiveMessageHeader::ControlMessage &msg, UnixMessage type) const
uint8_t *	data (SendMessageHeader::ControlMessage &msg) const

Detailed Description

Wrapper for the SCM_CREDENTIALS socket ancillary message to transfer process credentials between processes.

This ancillary message carries a UnixCredentials structure consisting of a ProcessID, UserID and GroupID. Both ends of a UNIX domain socket need to enable UnixOptions::setPassCredentials() for this to work.

On the sending side only the caller's ProcessID and one of its real, effective or saved UserIDs and/or GroupIDs may be specified. Privileged processes with CAP_SYS_ADMIN may specify arbitrary ProcessID, with CAP_SETUID may specify arbitrary UserIDs and GroupIDs.

Once the socket option is set each received message will carry an implicit UnixCredentialsMessage, even if the peer did not send one. This is automatically filled in by the kernel with the process's PID and real UserID and GroupID.

Definition at line 190 of file unix_aux.hxx.

Member Function Documentation

creds()

const UnixCredentials & cosmos::UnixCredentialsMessage::creds ( ) const

inline

Definition at line 202 of file unix_aux.hxx.

                                             {
                return m_creds;
        }

deserialize()

void cosmos::UnixCredentialsMessage::deserialize

(

const ReceiveMessageHeader::ControlMessage &

msg

)

Definition at line 71 of file unix_aux.cxx.

                                                                                      {
        checkMsg(msg, UnixMessage::CREDENTIALS);
 
        const uint8_t *data = reinterpret_cast<const uint8_t*>(msg.data());
        const auto bytes = msg.dataLength();
 
        if (bytes != sizeof(m_creds)) {
                cosmos_throw (RuntimeError("SCM_CREDS message with mismatching length encountered"));
        }
 
        std::memcpy(&m_creds, data, bytes);
}

serialize()

SendMessageHeader::ControlMessage cosmos::UnixCredentialsMessage::serialize

(

)

const

Definition at line 84 of file unix_aux.cxx.

                                                                        {
        auto ret = this->createMsg(UnixMessage::CREDENTIALS, sizeof(m_creds));
 
        auto data = this->data(ret);
 
        std::memcpy(data, &m_creds, sizeof(m_creds));
 
        return ret;
}

setCreds()

void cosmos::UnixCredentialsMessage::setCreds ( const UnixCredentials & creds )

inline

Definition at line 198 of file unix_aux.hxx.

                                                    {
                m_creds = creds;
        }

Member Data Documentation

m_creds

UnixCredentials cosmos::UnixCredentialsMessage::m_creds

protected

Definition at line 208 of file unix_aux.hxx.

---

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

• include/net/unix_aux.hxx
• src/net/unix_aux.cxx