glibmm 2.55.2

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::Credentials Class Reference

An object containing credentials. More...

`#include <giomm/credentials.h>`

Inheritance diagram for Gio::Credentials:
[legend]

## Public Types
enum | Type { Type::INVALID, Type::LINUX_UCRED, Type::FREEBSD_CMSGCRED, Type::OPENBSD_SOCKPEERCRED, Type::SOLARIS_UCRED, Type::NETBSD_UNPCBID }
| Enumeration describing different kinds of native credential types. More...
Public Types inherited from Glib::Object
using | DestroyNotify = void(*)(gpointer data)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Public Member Functions
| Credentials (Credentials&& src) noexcept
Credentials& | operator= (Credentials&& src) noexcept
| ~Credentials () noexcept override
GCredentials* | gobj ()
| Provides access to the underlying C GObject. More...
const GCredentials* | gobj () const
| Provides access to the underlying C GObject. More...
GCredentials* | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
Glib::ustring | to_string () const
| Creates a human-readable textual representation of credentials that can be used in logging and debug messages. More...
gpointer | get_native (Type native_type)
| Gets a pointer to native credentials of type native_type from credentials. More...
void | set_native (Type native_type, gpointer native)
| Copies the native credentials of type native_type from native into credentials. More...
bool | is_same_user (const Glib::RefPtr< const Credentials >& other_credentials)
| Checks if credentials and other_credentials is the same user. More...
uid_t | get_unix_user ()
| Tries to get the UNIX user identifier from credentials. More...
bool | set_unix_user (uid_t uid)
| Tries to set the UNIX user identifier on credentials. More...
pid_t | get_unix_pid () const
| Tries to get the UNIX process identifier from credentials. More...
Public Member Functions inherited from Glib::Object
| Object (const Object&)=delete
Object& | operator= (const Object&)=delete
| Object (Object&& src) noexcept
Object& | operator= (Object&& src) noexcept
void* | get_data (const QueryQuark& key)
void | set_data (const Quark& key, void* data)
void | set_data (const Quark& key, void* data, DestroyNotify notify)
void | remove_data (const QueryQuark& quark)
void* | steal_data (const QueryQuark& quark)
Public Member Functions inherited from Glib::ObjectBase
| ObjectBase (const ObjectBase&)=delete
ObjectBase& | operator= (const ObjectBase&)=delete
void | set_property_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
| You probably want to use a specific property_*() accessor method instead. More...
void | get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
| You probably want to use a specific property_*() accessor method instead. More...
template<class PropertyType >
void | set_property (const Glib::ustring& property_name, const PropertyType& value)
| You probably want to use a specific property_*() accessor method instead. More...
template<class PropertyType >
void | get_property (const Glib::ustring& property_name, PropertyType& value) const
| You probably want to use a specific property_*() accessor method instead. More...
template<class PropertyType >
PropertyType | get_property (const Glib::ustring& property_name) const
| You probably want to use a specific property_*() accessor method instead. More...
sigc::connection | connect_property_changed (const Glib::ustring& property_name, const sigc::slot< void()>& slot)
| You can use the signal_changed() signal of the property proxy instead. More...
sigc::connection | connect_property_changed (const Glib::ustring& property_name, sigc::slot< void()>&& slot)
| You can use the signal_changed() signal of the property proxy instead. More...
void | freeze_notify ()
| Increases the freeze count on object. More...
void | thaw_notify ()
| Reverts the effect of a previous call to freeze_notify(). More...
virtual void | reference () const
| Increment the reference count for this object. More...
virtual void | unreference () const
| Decrement the reference count for this object. More...
GObject* | gobj ()
| Provides access to the underlying C GObject. More...
const GObject* | gobj () const
| Provides access to the underlying C GObject. More...
GObject* | gobj_copy () const
| Give a ref-ed copy to someone. Use for direct struct access. More...
Public Member Functions inherited from sigc::trackable
| trackable () noexcept
| trackable (const trackable &src) noexcept
| trackable (trackable &&src)
| ~trackable ()
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const
void | notify_callbacks ()
trackable & | operator= (const trackable &src)
trackable & | operator= (trackable &&src)
void | remove_destroy_notify_callback (void *data) const

## Static Public Member Functions
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...
static Glib::RefPtr< Credentials > | create ()

## Protected Member Functions
| Credentials ()
Protected Member Functions inherited from Glib::Object
| Object ()
| Object (const Glib::ConstructParams& construct_params)
| Object (GObject* castitem)
| ~Object () noexcept override
Protected Member Functions inherited from Glib::ObjectBase
| ObjectBase ()
| This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. More...
| ObjectBase (const char* custom_type_name)
| A derived constructor always overrides this choice. More...
| ObjectBase (const std::type_info& custom_type_info)
| This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. More...
| ObjectBase (ObjectBase&& src) noexcept
ObjectBase& | operator= (ObjectBase&& src) noexcept
virtual | ~ObjectBase () noexcept=0
void | initialize (GObject* castitem)
void | initialize_move (GObject* castitem, Glib::ObjectBase* previous_wrapper)

## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gio::Credentials > | wrap (GCredentials* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Glib::Object
Glib::RefPtr< Glib::Object > | wrap (GObject* object, bool take_copy=false)

## Detailed Description

An object containing credentials.

The Credentials type is a reference-counted wrapper for native credentials. This information is typically used for identifying, authenticating and authorizing other processes.

Some operating systems supports looking up the credentials of the remote peer of a communication endpoint - see e.g. Gio::Socket::get_credentials().

Some operating systems supports securely sending and receiving credentials over a Unix Domain Socket, see UnixCredentialsMessage, Gio::UnixConnection::send_credentials() and Gio::UnixConnection::receive_credentials() for details.

On Linux, the native credential type is a struct ucred - see the unix(7) man page for details. This corresponds to Gio::CREDENTIALS_TYPE_LINUX_UCRED.

On FreeBSD, the native credential type is a struct cmsgcred. This corresponds to Gio::CREDENTIALS_TYPE_FREEBSD_CMSGCRED.

Since glibmm 2.28:

## Constructor & Destructor Documentation

## ◆ Credentials() [1/2]

Gio::Credentials::Credentials | ( | Credentials&& | src | ) |
| noexcept

## ◆ ~Credentials()

Gio::Credentials::~Credentials | ( |  | ) |
| override noexcept

## ◆ Credentials() [2/2]

Gio::Credentials::Credentials | ( |  | ) |
| protected

## Member Function Documentation

## ◆ create()

static Glib::RefPtr<Credentials> Gio::Credentials::create | ( |  | ) |
| static

## ◆ get_native()

gpointer Gio::Credentials::get_native | ( | Type | native_type | ) |

Gets a pointer to native credentials of type native_type from credentials.

It is a programming error (which will cause an warning to be logged) to use this method if there is no Credentials support for the OS or if native_type isn't supported by the OS.

Since glibmm 2.26:

Parameters

  native_type | The type of native credentials to get.

Returns
  The pointer to native credentials or `nullptr` if the operation there is no Credentials support for the OS or if native_type isn't supported by the OS. Do not free the returned data, it is owned by credentials.

## ◆ get_type()

static GType Gio::Credentials::get_type | ( |  | ) |
| static

Get the GType for this class, for use with the underlying GObject type system.

## ◆ get_unix_pid()

pid_t Gio::Credentials::get_unix_pid | ( |  | ) | const

Tries to get the UNIX process identifier from credentials.

This method is only available on UNIX platforms.

This operation can fail if Credentials is not supported on the OS or if the native credentials type does not contain information about the UNIX process ID.

Since glibmm 2.36:

Returns
  The UNIX process ID, or -1 if error is set.

Exceptions

  Gio::Error |

## ◆ get_unix_user()

uid_t Gio::Credentials::get_unix_user | ( |  | ) |

Tries to get the UNIX user identifier from credentials.

This method is only available on UNIX platforms.

This operation can fail if Credentials is not supported on the OS or if the native credentials type does not contain information about the UNIX user.

Since glibmm 2.26:

Returns
  The UNIX user identifier or -1 if error is set.

Exceptions

  Gio::Error |

## ◆ gobj() [1/2]

GCredentials* Gio::Credentials::gobj | ( |  | ) |
| inline

Provides access to the underlying C GObject.

## ◆ gobj() [2/2]

const GCredentials* Gio::Credentials::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GObject.

## ◆ gobj_copy()

GCredentials* Gio::Credentials::gobj_copy | ( |  | ) |

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

## ◆ is_same_user()

bool Gio::Credentials::is_same_user | ( | const Glib::RefPtr< const Credentials >& | other_credentials | ) |

Checks if credentials and other_credentials is the same user.

This operation can fail if Credentials is not supported on the the OS.

Since glibmm 2.26:

Parameters

  other_credentials | A Credentials.

Returns
  `true` if credentials and other_credentials has the same user, `false` otherwise or if error is set.

Exceptions

  Gio::Error |

## ◆ operator=()

Credentials& Gio::Credentials::operator= | ( | Credentials&& | src | ) |
| noexcept

## ◆ set_native()

void Gio::Credentials::set_native | ( | Type | native_type,
|  | gpointer | native
| ) |  |

Copies the native credentials of type native_type from native into credentials.

It is a programming error (which will cause an warning to be logged) to use this method if there is no Credentials support for the OS or if native_type isn't supported by the OS.

Since glibmm 2.26:

Parameters

  native_type | The type of native credentials to set.
  native | A pointer to native credentials.

## ◆ set_unix_user()

bool Gio::Credentials::set_unix_user | ( | uid_t | uid | ) |

Tries to set the UNIX user identifier on credentials.

This method is only available on UNIX platforms.

This operation can fail if Credentials is not supported on the OS or if the native credentials type does not contain information about the UNIX user. It can also fail if the OS does not allow the use of "spoofed" credentials.

Since glibmm 2.26:

Parameters

  uid | The UNIX user identifier to set.

Returns
  `true` if uid was set, `false` if error is set.

Exceptions

  Gio::Error |

## ◆ to_string()

Glib::ustring Gio::Credentials::to_string | ( |  | ) | const

Creates a human-readable textual representation of credentials that can be used in logging and debug messages.

The format of the returned string may change in future GLib release.

Since glibmm 2.26:

Returns
  A string.

## Friends And Related Function Documentation

## ◆ wrap()

Glib::RefPtr< Gio::Credentials > wrap | ( | GCredentials * | object,
|  | bool | take_copy = `false`
| ) |  |
| related

A Glib::wrap() method for this object.

Parameters

  object | The C instance.
  take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns
  A C++ instance that wraps this C instance.