README

linux-user

Node module for Linux user and group control.

Use Node to manage Linux user easily. All APIs do what you think. Promise and async\await out of the box. ES5 support! Zero dependences!

The module must be running on Linux and as root user !

Notes

This is a fork of wxygeek abandoned linux-user project.

Installation

$ npm install linux-sys-user --save

Testing

$ npm test

The testing libraries only work with NodeJS 6 and up.

Usage

This works with your normal require and execute callback functions. Every method takes a callback and is non-blocking.

Examples

add Linux user

var linuxUser = require('linux-sys-user');

linuxUser.addUser({username:"gkuchan", create_home:true, shell:null}, function (err, user) {
  if(err) {
    return console.error(err);
  }
  console.log(user);
  // ------------------------------------------
  // { username: 'gkuchan',
  //   password: 'x',
  //   uid: 1001,
  //   gid: 1001,
  //   fullname: '',
  //   homedir: '/home/gkuchan',
  //   shell: '/usr/sbin/nologin' }
  // ------------------------------------------
});

get users

var linuxUser = require('linux-sys-user');

linuxUser.getUsers(function (err, users) {
  if(err) {
    return console.error(err);
  }
  console.log(users);
  // ------------------------------------------
  // [ { username: 'root',
  //   password: 'x',
  //   uid: 0,
  //   gid: 0,
  //   fullname: 'root',
  //   homedir: '/root',
  //   shell: '/bin/bash' },
  // { username: 'daemon',
  //   password: 'x',
  //   uid: 1,
  //   gid: 1,
  //   fullname: 'daemon',
  //   homedir: '/usr/sbin',
  //   shell: '/usr/sbin/nologin' },
  // { username: 'bin',
  //   password: 'x',
  //   uid: 2,
  //   gid: 2,
  //   fullname: 'bin',
  //   homedir: '/bin',
  //   shell: '/usr/sbin/nologin' } ]
  //   ------------------------------------------
  });

Promises

This project works with promises right out of the box! Just grab the promise function.

var linuxUser = require('linux-sys-user').promise();

This will NodeJS's util.promisify by default. You can pass your own promisify function like, like bluebird:

var bluebird = require('bluebird');
var linuxUser = require('linux-sys-user').promise(bluebird.promisify);

** bluebird is NOT included with this package! ** If you are using a older version of NodeJS( less then 8 ) you will need something like it.

This will work with .then(), .catch() and the async/await pattern.


let user = await addUser({username:"gkuchan", create_home:true, shell:null});
console.log(user);
  // ------------------------------------------
  // { username: 'gkuchan',
  //   password: 'x',
  //   uid: 1001,
  //   gid: 1001,
  //   fullname: '',
  //   homedir: '/home/gkuchan',
  //   shell: '/usr/sbin/nologin' }
  // ------------------------------------------

Core APIs

linuxUser.addUser(config, callback)

This method is a front end to the useradd command on your system. Please consult you systems man page for details on your version and implementation.

config Object

username String User name of the user to be created.
shell String or Null Path to the login shell, setting null will use /usr/sbin/nologin as the path.

The name of the user's login shell. The default is to leave this
field blank, which causes the system to select the default login
shell specified by the SHELL variable in /etc/default/useradd, or
an empty string by default.

create_home Boolean true will create the home directory, false will not.

home_dir String Path to the user home directory.

The new user will be created using HOME_DIR as the value for the
user's login directory. The default is to append the LOGIN name to
BASE_DIR and use that as the login directory name. The directory
HOME_DIR does not have to exist but will not be created if it is
missing.

expiredate String The date on which the user account will be disabled. The date is specified in the format YYYY-MM-DD..

If not specified, useradd will use the default expiry date
specified by the EXPIRE variable in /etc/default/useradd, or an
empty string (no expiry) by default.

skel String

The skeleton directory, which contains files and directories to be
copied in the user's home directory, when the home directory is
created by useradd.

This option is only valid if the -m (or --create-home) option is
specified.

If this option is not set, the skeleton directory is defined by the
SKEL variable in /etc/default/useradd or, by default, /etc/skel.

If possible, the ACLs and extended attributes are copied.

system Boolean Create a system account.

System users will be created with no aging information in
/etc/shadow, and their numeric identifiers are chosen in the
SYS_UID_MIN-SYS_UID_MAX range, defined in /etc/login.defs, instead
of UID_MIN-UID_MAX (and their GID counterparts for the creation of
groups).

Note that useradd will not create a home directory for such a user,
regardless of the default setting in /etc/login.defs (CREATE_HOME).
You have to specify the -m options if you want a home directory for
a system account to be created.

selinux_user String The SELinux user for the user's login.

The default is to leave this field blank, which causes the system to
select the default SELinux user.

callback function(err, userInfo)

linuxUser.removeUser(username, callback)
- username String
- callback function(err)
linuxUser.getUsers(callback)
- callback function(err, usersInfo)
linuxUser.getUserInfo(username, callback)
- username String
- callback function(err, userInfo)
linuxUser.getUserGroups(username, callback)
- username String
- callback function(err, groups)
linuxUser.setPassword(username, password, callback)
- username String
- password String
- callback function(err)
linuxUser.addGroup(groupname, callback)
- groupname String
- callback function(err, groupInfo)
linuxUser.removeGroup(groupname, callback)
- groupname String
- callback function(err)
linuxUser.getGroups(callback)
- callback function(err, groupsInfo)
linuxUser.getGroupInfo(groupname, callback)
- groupname String
- callback function(err, groupInfo)
linuxUser.addUserToGroup(username, groupname, callback)
- username String
- groupname String
- callback function(err)

Other APIs

linuxUser.validateUsername(username)
- return boolen
- check a string is a valid linux username or not
linuxUser.verifySSHKey(key, callback)
- key String
- callback function(err, key info)
linuxUser.addSSHtoUser(user, key, callback)
- user String
- key String
- callback function(err, true)

License

MIT

Usage no npm install needed!