From 633445be1a9be37ae727c044417f5607706cf4ae Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 26 Jun 2018 00:25:28 +0000 Subject: Initial commit --- doc/index.html | 163 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/libnsss/index.html | 97 +++++++++++++++++++++++++++++ doc/overview.html | 35 +++++++++++ doc/upgrade.html | 28 +++++++++ 4 files changed, 323 insertions(+) create mode 100644 doc/index.html create mode 100644 doc/libnsss/index.html create mode 100644 doc/overview.html create mode 100644 doc/upgrade.html (limited to 'doc') diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..49cf697 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,163 @@ + + + + + + nsss - a secure NSS-like implementation for small libcs + + + + + + +

+Software
+skarnet.org +

+ +

nsss

+ +

What is it ?

+ +

+ nsss is an implementation of a subset of the pwd.h, +group.h and shadow.h family of functions, +performing user database access on Unix systems. +

+ +

+ Usually, user database access via getpwnam() and similar +function is provided by the system's libc. However, not all libcs implement +a configurable backend for the user/group database. For instance the +musl libc, on Linux, only supports +the standard /etc/passwd mechanism; it also supports the +nscd protocol but this is not quite enough to implement the +full set of database access functions with certain backends (such as a +LDAP server). +

+ +

+ nsss is a secure implementation of configurable user/group/shadow +database access, providing getpwnam() et al. functionality +by communicating over a Unix domain socket with a daemon; the daemon +can perform lookups in any database it chooses. +

+ +

+ Unlike NSS, nsss does not perform dynamic module +loading, only adds a small footprint to the application's binary, +and does not add any complex decision engine into the client's address +space. Applications can be statically linked against the nsss +library, and still benefit from configurable user database access +functions. +

+ +

An overview of nsss

+ +

Installation

+ +

Requirements

+ +

A POSIX-compliant system with a standard C development environment
GNU make, version 3.81 or later
skalibs version +2.6.5.0 or later. It's a build-time requirement. It's also a run-time +requirement if you link against the shared version of the skalibs +library.

+ +

Licensing

+ +

+ nsss is free software. It is available under the +ISC license. +

+ +

Download

+ +

The current released version of nsss is 0.0.1.0.
Alternatively, you can checkout a copy of the +nsss +git repository: +
```
 git clone git://git.skarnet.org/nsss 
```
There's also a +GitHub mirror +of the nsss git repository.

+ +

Compilation

+ +

See the enclosed INSTALL file for installation details.

+ +

Upgrade notes

+ +

This page lists the differences to be aware of between +the previous versions of nsss and the current one.

+ +

Reference

+ +

Commands

+ +

+ + +

Libraries

+ +

The nsss library interface
The following primitives are also implemented: +
- endpwent()
- setpwent()
- getpwent()
- getpwent_r()
- getpwuid()
- getpwuid_r()
- getpwnam()
- getpwnam_r()
- endgrent()
- setgrent()
- getgrent()
- getgrent_r()
- getgrgid()
- getgrgid_r()
- getgrnam()
- getgrnam_r()
- endspent()
- setspent()
- getspent()
- getspent_r()
- getspnam()
- getspnam_r()

+ +

+ + +

Related resources

+ + +

nsss discussion

+ +

nsss is discussed on the +skaware mailing-list.

+ + + diff --git a/doc/libnsss/index.html b/doc/libnsss/index.html new file mode 100644 index 0000000..0307725 --- /dev/null +++ b/doc/libnsss/index.html @@ -0,0 +1,97 @@ + + + + + + nsss: the nsss library interface + + + + + + +

+nsss
+Software
+skarnet.org +

+ +

The `nsss` library interface

+ +

General information

+ +

+ libnsss is a client library meant to be used by client +programs needing utmp functionality. It interacts with various +server-side daemons such as +nsssd-unix. +

+ +

+ Application programs can use it directly, but most existing programs +simply use the standard +pwd.h, +grp.h or +shadow.h +interfaces, which in nsss are implemented as a series of thin wrappers +around the nsss library. +

+ +

Compiling

+ +

Make sure the nsss headers, as well as the skalibs headers, +are visible in your header search path.
Use #include <nsss/nsss.h>
To use the standard pwd.h interface, you can +just #include <pwd.h>, which will work as long +as the nsss/pwd.h header is accessible in your header +search path.
Same thing for grp.h and shadow.h.

+ +

Linking

+ +

Make sure the nsss library, as well as the skalibs library, +are visible in your library search path.
Link against -lnsss, -lskarnet,

`cat $SYSDEPS/socket.lib`

`cat $SYSDEPS/tainnow.lib`

+ +

Programming

+ +

+ The nsss/nsss.h header is actually a collection of headers: +

+ +

nsss/nsss-unix.h implements basic access to the +/etc/passwd, /etc/group and /etc/shadow +database.
nsss/nsss-switch.h implements connection via a Unix +domain socket to a listening nsssd daemon, implementing an +authentication backend based on what implementation of +the daemon is listening.
nsss/nsss-all.h implements a safe policy: first a +connection via nsss-switch is attempted, and if no daemon +is listening, the safe nsss-unix backend is used.

+ +

+ By default, the getpwnam() et al. functions are aliased +to their nsss-all implementations. You can disable the +nsss-unix fallback by compiling with the NSSS_DISABLE_UNIX +macro defined (-DNSSS_DISABLE_UNIX). Or you can disable any +attempt to connect to a daemon by compiling with the +NSSS_DISABLE_SWITCH macro defined (-DNSSS_DISABLE_SWITCH). +

+ +

+ (To be completed.) +

+ + + diff --git a/doc/overview.html b/doc/overview.html new file mode 100644 index 0000000..222e296 --- /dev/null +++ b/doc/overview.html @@ -0,0 +1,35 @@ + + + + + + nsss: an overview + + + + + + +

+nsss
+Software
+skarnet.org +

+ +

An overview of nsss

+ +

+ nsss is a secure implementation of a subset of the +pwd.h, grp.h and shadow.h functionality, i.e. +user authentication on Unix systems. It includes full POSIX +functionality, a few GNU extensions, and an underlying +C client library with better error reporting +than the POSIX interface specifies. +

+ +

+ To be completed. +

+ + + diff --git a/doc/upgrade.html b/doc/upgrade.html new file mode 100644 index 0000000..5ff9e3b --- /dev/null +++ b/doc/upgrade.html @@ -0,0 +1,28 @@ + + + + + + How to upgrade nsss + + + + + + +

+nsss
+Software
+skarnet.org +

+ +

What has changed in nsss

+ +

in 0.0.1.0

+ +

+ Initial release. +

+ + + -- cgit v1.3.1

nsss

What is it ?

Installation

Requirements

Licensing

Download

Compilation

Upgrade notes

Reference

Commands

Libraries

Related resources

nsss discussion

The nsss library interface

General information

Compiling

Linking

Programming

An overview of nsss

What has changed in nsss

in 0.0.1.0

The `nsss` library interface