SignonIdentityInfo

SignonIdentityInfo — data contained in a SignonIdentity.

Functions

Types and Values

Object Hierarchy

    GBoxed
    ╰── SignonIdentityInfo

Description

SignonIdentityInfo represents data contained in a database record for an identity and provides getters and setters for individual items.

See SignonIdentity for a detailed discussion of what each item means and how and when it's used.

Functions

signon_identity_info_new ()

SignonIdentityInfo *
signon_identity_info_new ();

Creates a new SignonIdentityInfo item.

Returns

a new SignonIdentityInfo item.


signon_identity_info_free ()

void
signon_identity_info_free (SignonIdentityInfo *info);

Destroys the given SignonIdentityInfo item.

Parameters

info

the SignonIdentityInfo.

 

signon_identity_info_copy ()

SignonIdentityInfo *
signon_identity_info_copy (const SignonIdentityInfo *other);

Get a newly-allocated copy of info .

Parameters

other

the SignonIdentityInfo.

 

Returns

a copy of the given SignonIdentityInfo, or NULL on failure.


signon_identity_info_get_id ()

gint
signon_identity_info_get_id (const SignonIdentityInfo *info);

Get the numeric identity ID of info .

Parameters

info

the SignonIdentityInfo.

 

Returns

the numeric ID of the identity.


signon_identity_info_get_username ()

const gchar *
signon_identity_info_get_username (const SignonIdentityInfo *info);

Get the username associated with an identity.

Parameters

info

the SignonIdentityInfo.

 

Returns

the username, or NULL.


signon_identity_info_get_storing_secret ()

gboolean
signon_identity_info_get_storing_secret
                               (const SignonIdentityInfo *info);

Get whether the secret of info should be stored by gSSO in the secret database.

Parameters

info

the SignonIdentityInfo.

 

Returns

TRUE if gSSO must store the secret, FALSE otherwise.


signon_identity_info_get_caption ()

const gchar *
signon_identity_info_get_caption (const SignonIdentityInfo *info);

Get the display name of info .

Parameters

info

the SignonIdentityInfo.

 

Returns

the display name for the identity.


signon_identity_info_get_methods ()

GHashTable *
signon_identity_info_get_methods (const SignonIdentityInfo *info);

Get a hash table of the methods and mechanisms of info . See signon_identity_info_set_methods().

Parameters

info

the SignonIdentityInfo.

 

Returns

the table of allowed methods and mechanisms.

[transfer none][element-type utf8 GStrv]


signon_identity_info_get_realms ()

const gchar * const *
signon_identity_info_get_realms (const SignonIdentityInfo *info);

Get an array of the allowed realms of info .

Parameters

info

the SignonIdentityInfo.

 

Returns

a NULL terminated array of realms.

[transfer none][array zero-terminated=1]


signon_identity_info_get_owner ()

const SignonSecurityContext *
signon_identity_info_get_owner (const SignonIdentityInfo *info);

Get identity owner's security context.

Parameters

info

the SignonIdentityInfo.

 

Returns

a security context.

[transfer none]


signon_identity_info_get_access_control_list ()

GList *
signon_identity_info_get_access_control_list
                               (const SignonIdentityInfo *info);

Get an access control list associated with an identity.

Parameters

info

the SignonIdentityInfo.

 

Returns

a list of ACL security contexts.

[transfer none][element-type SignonSecurityContext]


signon_identity_info_get_identity_type ()

SignonIdentityType
signon_identity_info_get_identity_type
                               (const SignonIdentityInfo *info);

Get the type of the identity.

Parameters

info

the SignonIdentityInfo.

 

Returns

the type of the identity.


signon_identity_info_set_username ()

void
signon_identity_info_set_username (SignonIdentityInfo *info,
                                   const gchar *username);

Sets the username for the identity.

Parameters

info

the SignonIdentityInfo.

 

username

the username.

 

signon_identity_info_set_secret ()

void
signon_identity_info_set_secret (SignonIdentityInfo *info,
                                 const gchar *secret,
                                 gboolean store_secret);

Sets the secret (password) for the identity, and whether the gSSO daemon should remember it.

Parameters

info

the SignonIdentityInfo.

 

secret

the secret.

 

store_secret

whether signond should store the secret in its DB.

 

signon_identity_info_set_caption ()

void
signon_identity_info_set_caption (SignonIdentityInfo *info,
                                  const gchar *caption);

Sets the caption (display name) for the identity.

Parameters

info

the SignonIdentityInfo.

 

caption

the caption.

 

signon_identity_info_set_methods ()

void
signon_identity_info_set_methods (SignonIdentityInfo *info,
                                  GHashTable *methods);

Set authentication methods that are allowed to be used with this identity.

Parameters

info

the SignonIdentityInfo.

 

methods

methods.

[transfer none][element-type utf8 GStrv]

signon_identity_info_own_methods ()

void
signon_identity_info_own_methods (SignonIdentityInfo *info,
                                  GHashTable *methods);

Set authentication methods that are allowed to be used with this identity.

This function will just increment reference count of hash table, so it should be constructed with g_hash_table_new_full.

Parameters

info

the SignonIdentityInfo.

 

methods

methods.

[transfer none][element-type utf8 GStrv]

signon_identity_info_set_method ()

void
signon_identity_info_set_method (SignonIdentityInfo *info,
                                 const gchar *method,
                                 const gchar * const *mechanisms);

Adds a method to the list of allowed authentication methods.

Parameters

info

the SignonIdentityInfo.

 

method

an authentication method.

 

mechanisms

a NULL-terminated list of mechanisms.

[array zero-terminated=1]

signon_identity_info_remove_method ()

void
signon_identity_info_remove_method (SignonIdentityInfo *info,
                                    const gchar *method);

Remove method from the list of allowed authentication methods.

Parameters

info

the SignonIdentityInfo.

 

method

an authentication method.

 

signon_identity_info_set_realms ()

void
signon_identity_info_set_realms (SignonIdentityInfo *info,
                                 const gchar * const *realms);

Specify what realms this identity can be used in.

Parameters

info

the SignonIdentityInfo.

 

realms

a NULL-terminated list of realms.

[array zero-terminated=1]

signon_identity_info_set_owner ()

void
signon_identity_info_set_owner (SignonIdentityInfo *info,
                                const SignonSecurityContext *owner);

Set identity owner's security context.

Parameters

info

the SignonIdentityInfo.

 

owner

a security context of owner.

[transfer none]

signon_identity_info_set_owner_from_values ()

void
signon_identity_info_set_owner_from_values
                               (SignonIdentityInfo *info,
                                const gchar *system_context,
                                const gchar *application_context);

Set identity owner's security context.

Parameters

info

the SignonIdentityInfo.

 

system_context

owner's system context.

 

application_context

owner's application context.

 

signon_identity_info_set_access_control_list ()

void
signon_identity_info_set_access_control_list
                               (SignonIdentityInfo *info,
                                GList *access_control_list);

Set an access control list associated with an identity.

Parameters

info

the SignonIdentityInfo.

 

access_control_list

a list of ACL security contexts.

[element-type SignonSecurityContext]

signon_identity_info_access_control_list_append ()

void
signon_identity_info_access_control_list_append
                               (SignonIdentityInfo *info,
                                SignonSecurityContext *security_context);

Appends a new SignonSecurityContext item to the access control list.

Parameters

info

the SignonIdentityInfo.

 

security_context

a security context to be appended.

[transfer full]

signon_identity_info_set_identity_type ()

void
signon_identity_info_set_identity_type
                               (SignonIdentityInfo *info,
                                SignonIdentityType type);

Specifies the type of this identity.

Parameters

info

the SignonIdentityInfo.

 

type

the type of the identity.

 

Types and Values

enum SignonIdentityType

Identity types used in SignonIdentityInfo.

Members

SIGNON_IDENTITY_TYPE_OTHER

an identity that is not an app, web or network

 

SIGNON_IDENTITY_TYPE_APP

an application identity

 

SIGNON_IDENTITY_TYPE_WEB

a web identity

 

SIGNON_IDENTITY_TYPE_NETWORK

a network server identity

 

SignonIdentityInfo

typedef struct _SignonIdentityInfo SignonIdentityInfo;

Opaque struct. Use the accessor functions below.