gio/org.gtkkn.bindings.gio/Credentials

Credentials

open class Credentials(val gioCredentialsPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

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. method@Gio.Socket.get_credentials.

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

On Linux, the native credential type is a struct ucred - see the man:unix(7) 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.

Since

2.26

Constructors

Credentials

constructor()

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

constructor(gioCredentialsPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioCredentialsPointer

val gioCredentialsPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

getNative

open fun getNative(nativeType: CredentialsType): <Error class: unknown class>?

Gets a pointer to native credentials of type @native_type from

getUnixPid

open fun getUnixPid(): <Error class: unknown class><<Error class: unknown class>>

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

getUnixUser

open fun getUnixUser(): <Error class: unknown class><<Error class: unknown class>>

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

isSameUser

open fun isSameUser(otherCredentials: Credentials): <Error class: unknown class><Boolean>

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

setNative

open fun setNative(nativeType: CredentialsType, native: <Error class: unknown class>)

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

setUnixUser

open fun setUnixUser(uid: <Error class: unknown class>): <Error class: unknown class><Boolean>

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

toString

open override fun toString(): String

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.