Struct Credentials

pub struct Credentials { /* private fields */ }

The GCredentials type is a reference-counted wrapper for native credentials.

The information in GCredentials 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. SocketExt::credentials().

Some operating systems supports securely sending and receiving credentials over a Unix Domain Socket, see UnixCredentialsMessage, UnixConnectionExt::send_credentials() and UnixConnectionExt::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 G_CREDENTIALS_TYPE_LINUX_UCRED.

On Apple operating systems (including iOS, tvOS, and macOS), the native credential type is a struct xucred. This corresponds to G_CREDENTIALS_TYPE_APPLE_XUCRED.

On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native credential type is a struct cmsgcred. This corresponds to G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.

On NetBSD, the native credential type is a struct unpcbid. This corresponds to G_CREDENTIALS_TYPE_NETBSD_UNPCBID.

On OpenBSD, the native credential type is a struct sockpeercred. This corresponds to G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED.

On Solaris (including OpenSolaris and its derivatives), the native credential type is a ucred_t. This corresponds to G_CREDENTIALS_TYPE_SOLARIS_UCRED.

Since GLib 2.72, on Windows, the native credentials may contain the PID of a process. This corresponds to G_CREDENTIALS_TYPE_WIN32_PID.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Credentials

pub fn native(&self, native_type: CredentialsType) -> gpointer

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

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

native_type

The type of native credentials to get.

Returns

The pointer to native credentials or None if there is no #GCredentials support for the OS or if @native_type isn’t supported by the OS. Do not free the returned data, it is owned by @self.

pub fn unix_pid(&self) -> Result<pid_t, Error>

Available on Unix only.

Tries to get the UNIX process identifier from @self. This method is only available on UNIX platforms.

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

Returns

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

pub fn unix_user(&self) -> Result<uid_t, Error>

Available on Unix only.

Tries to get the UNIX user identifier from @self. This method is only available on UNIX platforms.

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

Returns

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

pub unsafe fn set_native(&self, native_type: CredentialsType, native: gpointer)

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

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

native_type

The type of native credentials to set.

native

A pointer to native credentials.

pub fn set_unix_user(&self, uid: uid_t) -> Result<(), Error>

Available on Unix only.

Tries to set the UNIX user identifier on @self. This method is only available on UNIX platforms.

This operation can fail if #GCredentials 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.

uid

The UNIX user identifier to set.

Returns

true if @uid was set, false if error is set.

impl Credentials

pub fn new() -> Credentials

Creates a new #GCredentials object with credentials matching the the current process.

Returns

A #GCredentials. Free with g_object_unref().

pub fn is_same_user(&self, other_credentials: &Credentials) -> Result<(), Error>

Checks if @self and @other_credentials is the same user.

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

other_credentials

A #GCredentials.

Returns

true if @self and @other_credentials has the same user, false otherwise or if @error is set.

pub fn to_str(&self) -> GString

Creates a human-readable textual representation of @self that can be used in logging and debug messages. The format of the returned string may change in future GLib release.

Returns

A string that should be freed with g_free().

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Credentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Credentials

fn default() -> Self

Returns the “default value” for a type.

impl Display for Credentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Credentials

type ParamSpec = ParamSpecObject

type SetValue = Credentials

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Credentials>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Credentials

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Credentials

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Credentials

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Credentials

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Credentials

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Credentials

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Credentials