diff options
| author | Daniil Baturin <daniil@vyos.io> | 2026-05-08 14:30:38 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-08 14:30:38 +0100 |
| commit | 44a3adec817e095b7fcb0fbee1b65abff438591f (patch) | |
| tree | f4c3489b6d5ca40646d194615295432fabda121c | |
| parent | a61d55f0198dd70a6d09d731672baa5e0c122280 (diff) | |
| parent | f250d2a739b5128ead1f516979c413db5261045d (diff) | |
| download | libtacplus-map-44a3adec817e095b7fcb0fbee1b65abff438591f.tar.gz libtacplus-map-44a3adec817e095b7fcb0fbee1b65abff438591f.zip | |
Merge pull request #4 from vyos/T8595-add-agents-md
general: T8595: switch CLAUDE.md to AGENTS.md (+ Copilot symlink)
| l--------- | .github/copilot-instructions.md | 2 | ||||
| -rw-r--r--[l---------] | AGENTS.md | 44 | ||||
| -rw-r--r-- | CLAUDE.md | 47 |
3 files changed, 44 insertions, 49 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 949a29f..be77ac8 120000 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1 +1 @@ -../CLAUDE.md
\ No newline at end of file +../AGENTS.md
\ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md index 681311e..5bb3cdf 120000..100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1 +1,43 @@ -CLAUDE.md
\ No newline at end of file +# AGENTS.md + +## Project purpose + +Helper library for local mapping of TACACS+-authenticated users that have no `/etc/passwd` entry. Stores per-session mappings (uid/gid/home) so `libnss-tacplus` can answer `getpwnam` for users that came in via `libpam-tacplus`. Ships `libtacplus-map1` (runtime) and `libtacplus-map-dev` (headers); also includes `dumpmap` (debug tool) and a sudoers fragment. + +## Tech stack + +- C, GNU autotools (`configure.ac`, `Makefile.am`, `auto.sh`). +- Debian packaging in `debian/` (debhelper >= 9, `dh-autoreconf`, `autoconf-archive`, `libaudit-dev`). +- License: GPL-2.0 (per `COPYING`). + +## Build / test / run + +```sh +./auto.sh +make +dpkg-buildpackage -us -uc +``` + +No bundled tests; verified end-to-end via `libnss-tacplus` + `libpam-tacplus` on a VyOS image. + +## Repository layout + +- `map_tacplus_user.c`, `map_tacplus_user.h` — mapping API. +- `dumpmap.c` — diagnostic tool that dumps the active mapping. +- `tacplus.sudo` — sudoers integration snippet. +- `debian/` — packaging. + +## Cross-repo context + +Sits between `libpam-tacplus` (which authenticates the user and creates the mapping) and `libnss-tacplus` (which reads the mapping for NSS lookups). Built via the internal build-packages workflow; consumed by `vyos/vyos-build`. Sibling auth packages: `libnss-mapuser`, `libpam-radius-auth`. + +## Conventions + +- Default branch `master`. +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). +- Keep API stable — `libnss-tacplus` and `libpam-tacplus` link against this and are version-coupled. + +## Notes for future contributors + +- README dates to 2016 (`libtacplus_map v1.0.0`). Tracking patches against the original Cumulus / Dell drop is the maintenance posture, not active development. +- Bump `libtacplus-map1` soname on any ABI change — both `libnss-tacplus` and `libpam-tacplus` build-depend on the dev package. diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index 9892db4..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1,47 +0,0 @@ -# CLAUDE.md - -## Project purpose - -Helper library for local mapping of TACACS+-authenticated users that have no `/etc/passwd` entry. Stores per-session mappings (uid/gid/home) so `libnss-tacplus` can answer `getpwnam` for users that came in via `libpam-tacplus`. Ships `libtacplus-map1` (runtime) and `libtacplus-map-dev` (headers); also includes `dumpmap` (debug tool) and a sudoers fragment. - -## Tech stack - -- C, GNU autotools (`configure.ac`, `Makefile.am`, `auto.sh`). -- Debian packaging in `debian/` (debhelper >= 9, `dh-autoreconf`, `autoconf-archive`, `libaudit-dev`). -- License: GPL-2.0 (per `COPYING`). - -## Build / test / run - -```sh -./auto.sh -make -dpkg-buildpackage -us -uc -``` - -No bundled tests; verified end-to-end via `libnss-tacplus` + `libpam-tacplus` on a VyOS image. - -## Repository layout - -- `map_tacplus_user.c`, `map_tacplus_user.h` — mapping API. -- `dumpmap.c` — diagnostic tool that dumps the active mapping. -- `tacplus.sudo` — sudoers integration snippet. -- `debian/` — packaging. - -## Cross-repo context - -Sits between `libpam-tacplus` (which authenticates the user and creates the mapping) and `libnss-tacplus` (which reads the mapping for NSS lookups). Built via `VyOS-Networks/vyos-build-packages`; consumed by `vyos/vyos-build`. Sibling auth packages: `libnss-mapuser`, `libpam-radius-auth`. - -## Conventions - -- Default branch `master`. -- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). -- Keep API stable — `libnss-tacplus` and `libpam-tacplus` link against this and are version-coupled. - -## Mirror relationship - -Mirror twin: `VyOS-Networks/libtacplus-map`. Canonical side is here. - -## Notes for future contributors - -- README dates to 2016 (`libtacplus_map v1.0.0`). Tracking patches against the original Cumulus / Dell drop is the maintenance posture, not active development. -- Bump `libtacplus-map1` soname on any ABI change — both `libnss-tacplus` and `libpam-tacplus` build-depend on the dev package. |
