getpwnam, getpwnam_r, getpwuid, getpwuid_r − Lire un enregistrement du fichier des mots de passe.

#include <sys/types.h>
#include <pwd.h>

struct passwd *getpwnam (const char * name);

struct passwd *getpwuid (uid_t uid);

int getpwnam_r(const char *name, struct passwd *pwbuf,
        char *buf, size_t buflen, struct passwd **pwbufp);

int getpwuid_r(uid_t uid, struct passwd *pwbuf,
        char *buf, size_t buflen, struct passwd **pwbufp);

La fonction getpwnam() renvoie un pointeur sur une structure contenant les divers champs de l’enregistrement de la base de données des mots de passe (par exemple, la base de données locale /etc/passwd, NIS ou LDAP) correspondant au nom d’utilisateur name.

La fonction getpwuid() renvoie un pointeur sur une structure contenant les divers champs de l’enregistrement de la base de données des mots de passe correspondant à l’UID uid.

Les fonctions getpwnam_r() et getpwuid_r() cherchent les mêmes informations mais enregistrent la structure passwd trouvée dans l’espace pointé par pwbuf. Cette structure passwd contient des pointeurs vers des chaînes, et ces chaînes sont enregistrées dans le tampon buf de taille buflen. Un pointeur vers le résultat (en cas de succès) ou NULL (au cas où aucune entrée n’ait été trouvée ou qu’une erreur ne soit survenue) est enregistré dans *pwbufp.

La structure passwd est définie dans <pwd.h> ainsi :

struct passwd {
    char   *pw_name;   /* Nom d’utilisateur             */
    char   *pw_passwd; /* Mot de passe                  */
    uid_t   pw_uid;    /* ID de l’utilisateur           */
    gid_t   pw_gid;    /* ID du groupe de l’utilisateur */
    char   *pw_gecos;  /* Nom réel de l’utilisateur     */
    char   *pw_dir;    /* Répertoire de connexion       */
    char   *pw_shell;  /* Programme Shell de connexion  */
};

La taille maximum nécessaire pour buf peut être récupérée en utilisant sysconf(3) avec le paramètre _SC_GETPW_R_SIZE_MAX.

Les fonctions getpwnam() et getpwuid() renvoient un pointeur sur une structure passwd, ou NULL si une erreur se produit, ou si l’enregistrement correspondant n’est pas trouvé. En cas d’erreur, errno est remplie en conséquence. Si on souhaite vérifier errno après l’appel, celle-ci devrait être remplie avec zéro avant l’appel.

La valeur de retour peut pointer vers une zone statique et donc être écrasée par des appels successifs à getpwent(), getpwnam() ou getpwuid().

Les fonctions getpwnam_r() et getpwuid_r() renvoyent zéro si elles réussissent. En cas d’erreur, une valeur d’erreur est renvoyée.

0 ou ENOENT ou ESRCH ou EBADF ou EPERM ou ...

Le nom name ou l’identifiant uid n’ont pas été trouvés.

EINTR

Un signal a été capturé.

EIO

Erreur d’entrée-sortie.

EMFILE

Le nombre maximal (OPEN_MAX) de fichiers ouverts pour le processus est atteint.

ENFILE

Le nombre maximal de fichiers ouverts sur le système est atteint.

ENOMEM

Pas assez de mémoire pour allouer la structure passwd.

ERANGE

L’espace tampon fourni est insuffisant.

/etc/passwd

Base de données locale des mots de passe.

SVr4, BSD 4.3, POSIX.1-2001.

La description "VALEUR RENVOYÃE" ci-dessus vient de POSIX.1-2001. Elle ne considère pas le cas « non trouvé » commme une erreur, et ne spécifie pas errno dans ce cas. Cela rend la détection d’erreur impossible. On peut dire que, d’après POSIX, errno est inchangée dans le cas où aucune entrée n’est trouvée. Des essais sur de nombreux systèmes Unix ont fait apparaître différentes valeurs dans ce cas : 0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM et probablement d’autres.

Le champ pw_dir contient le nom du répertoire de travail initial de l’utilisateur. Les programmes de connexion utilisent la valeur de ce champ pour initialiser la variable d’environnement HOME du shell de connexion. Une application qui veut déterminer le répertoire personnel de l’utilisateur doit inspecter la valeur de HOME (plutôt que la valeur getpwuid(getuid())->pw_dir) puisque cela permet à l’utilisateur de modifier la notion de « répertoire personnel » lors d’une session de connexion. Pour déterminer le répertoire personnel (initial) d’un autre utilisateur, il est nécessaire d’utiliser getpwnam("username")->pw_dir ou similaire.

endpwent(3), fgetpwent(3), getpw(3), getgrnam(3), getpwent(3), putpwent(3), setpwent(3), passwd(5)

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 3 novembre 1996 et révisée le 14 août 2006.

L’équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 3 getpwnam ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.