midgard_user

midgard_user — User account and authentication

Synopsis


#include <midgard/midgard.h>

typedef             midgard_user;
typedef             MidgardUserClass;
                    MidgardUserPrivate;
                    MidgardUser;
MidgardUser *       midgard_user_new                    (MgdObject *person);
MidgardUser *       midgard_user_auth                   (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         const gchar *password,
                                                         const gchar *sitegroup,
                                                         gboolean trusted);
gboolean            midgard_user_is_user                (MidgardUser *self);
gboolean            midgard_user_is_admin               (MidgardUser *self);
gboolean            midgard_user_is_root                (MidgardUser *self);
gboolean            midgard_user_set_active             (MidgardUser *user,
                                                         gboolean flag);
gboolean            midgard_user_password               (MidgardUser *self,
                                                         const gchar *login,
                                                         const gchar *password,
                                                         guint hashtype);
MgdObject *         midgard_user_get_person             (MidgardUser *self);

Object Hierarchy

  GObject
   +----midgard_dbobject
         +----midgard_user

Properties

  "active"                   gboolean              : Read
  "guid"                     gchar*                : Read
  "hashtype"                 guint                 : Read
  "login"                    gchar*                : Read
  "password"                 gchar*                : Read
  "sitegroup"                guint                 : Read

Description

MidgardUser ( midgard_user ) class is a proxy between person records ( represented by built in midgard_person class ) and user's account. It also let's you authenticate using user's account and login into Midgard sitegroup. The easiest way to create new MidgardUser instance is by calling midgard_user_auth().

MidgardUser provides very basic and low level access control system.

Details

midgard_user

typedef struct _MidgardUser midgard_user;

MidgardUserClass

typedef struct MidgardUserClass MidgardUserClass;

MidgardUserPrivate

typedef struct _MidgardUserPrivate MidgardUserPrivate;

MidgardUser

typedef struct {
	GObject parent;
	MidgardDBObjectPrivate *dbpriv;
} MidgardUser;

midgard_user_new ()

MidgardUser *       midgard_user_new                    (MgdObject *person);

person :

Returns :

midgard_user_auth ()

MidgardUser *       midgard_user_auth                   (MidgardConnection *mgd,
                                                         const gchar *name,
                                                         const gchar *password,
                                                         const gchar *sitegroup,
                                                         gboolean trusted);

mgd :

name :

password :

sitegroup :

trusted :

Returns :

midgard_user_is_user ()

gboolean            midgard_user_is_user                (MidgardUser *self);

self :

Returns :

midgard_user_is_admin ()

gboolean            midgard_user_is_admin               (MidgardUser *self);

self :

Returns :

midgard_user_is_root ()

gboolean            midgard_user_is_root                (MidgardUser *self);

self :

Returns :

midgard_user_set_active ()

gboolean            midgard_user_set_active             (MidgardUser *user,
                                                         gboolean flag);

user :

flag :

Returns :

midgard_user_password ()

gboolean            midgard_user_password               (MidgardUser *self,
                                                         const gchar *login,
                                                         const gchar *password,
                                                         guint hashtype);

self :

login :

password :

hashtype :

Returns :

midgard_user_get_person ()

MgdObject *         midgard_user_get_person             (MidgardUser *self);

self :

Returns :

Property Details

The "active" property

  "active"                   gboolean              : Read

Default value: FALSE

The "guid" property

  "guid"                     gchar*                : Read

Default value: ""

The "hashtype" property

  "hashtype"                 guint                 : Read

Default value: 0

The "login" property

  "login"                    gchar*                : Read

Default value: ""

The "password" property

  "password"                 gchar*                : Read

Default value: ""

The "sitegroup" property

  "sitegroup"                guint                 : Read

Default value: 0

Generated by GTK-Doc V1.11