diff options
| l--------- | .github/copilot-instructions.md | 2 | ||||
| -rw-r--r--[l---------] | AGENTS.md | 47 | ||||
| -rw-r--r-- | CLAUDE.md | 50 |
3 files changed, 47 insertions, 52 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..9bf61bd 120000..100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1 +1,46 @@ -CLAUDE.md
\ No newline at end of file +# AGENTS.md + +## Project purpose + +PAM module providing TACACS+ authentication, authorization, and accounting for VyOS logins, plus the `libtac` TACACS+ protocol library and the `tacc` CLI client. Pairs with `libnss-tacplus` (NSS lookups) and `libtacplus-map` (user mapping) to deliver TACACS+ login on VyOS. + +## Tech stack + +- C, GNU autotools (`configure.ac`, `Makefile.am`, `auto.sh`). +- Debian packaging in `debian/` (debhelper >= 9, `libpam-dev`, `dh-autoreconf`, `autoconf-archive`, `libaudit-dev`). +- Builds Debian packages: `libpam-tacplus`, `libpam-tacplus-dev`, `libtac2`, `libtac2-bin`, `libtac-dev`. +- License: GPL-2.0 (per `COPYING`). + +## Build / test / run + +```sh +./auto.sh # autoreconf (generates./configure) +./configure +make +dpkg-buildpackage -us -uc +``` + +`tacc` is a small CLI client useful for manual testing (`tacc.1` man page). No bundled unit tests; Coverity scan badge in README references upstream. + +## Repository layout + +- `pam_tacplus.c`, `pam_tacplus.h`, `support.c/h` — PAM module. +- `libtac/` — protocol library (produces `libtac2`). +- `tacc.c`, `tacc.1` — CLI client. +- `tacplus_servers`, `tacplus_servers.5`, `Pam.d.common-example`, `sample.pam` — config + examples. +- `debian/`, `pam_tacplus.spec.in` — packaging. + +## Cross-repo context + +Authentication building block of the VyOS image. Provides the `libtac` library that `libnss-tacplus` links against, and the PAM module that `libtacplus-map` complements for `/etc/passwd`-less TACACS+ logins. Built via the internal build-packages workflow; consumed by `vyos/vyos-build`. + +## Conventions + +- Default branch `master`. LTS branches when needed. +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). +- Treat as upstream-vendored: minimise diffs against the upstream `pam_tacplus`. + +## Notes for future contributors + +- The `libtac/` subdirectory is the TACACS+ protocol library and is shipped as a separately versioned `libtac2` Debian package — bump the soname carefully. +- README is upstream's; VyOS-specific behaviour is encoded only by the build flags and patches applied here. diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index 99c6ceb..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1,50 +0,0 @@ -# CLAUDE.md - -## Project purpose - -PAM module providing TACACS+ authentication, authorization, and accounting for VyOS logins, plus the `libtac` TACACS+ protocol library and the `tacc` CLI client. Pairs with `libnss-tacplus` (NSS lookups) and `libtacplus-map` (user mapping) to deliver TACACS+ login on VyOS. - -## Tech stack - -- C, GNU autotools (`configure.ac`, `Makefile.am`, `auto.sh`). -- Debian packaging in `debian/` (debhelper >= 9, `libpam-dev`, `dh-autoreconf`, `autoconf-archive`, `libaudit-dev`). -- Builds Debian packages: `libpam-tacplus`, `libpam-tacplus-dev`, `libtac2`, `libtac2-bin`, `libtac-dev`. -- License: GPL-2.0 (per `COPYING`). - -## Build / test / run - -```sh -./auto.sh # autoreconf (generates ./configure) -./configure -make -dpkg-buildpackage -us -uc -``` - -`tacc` is a small CLI client useful for manual testing (`tacc.1` man page). No bundled unit tests; Coverity scan badge in README references upstream. - -## Repository layout - -- `pam_tacplus.c`, `pam_tacplus.h`, `support.c/h` — PAM module. -- `libtac/` — protocol library (produces `libtac2`). -- `tacc.c`, `tacc.1` — CLI client. -- `tacplus_servers`, `tacplus_servers.5`, `Pam.d.common-example`, `sample.pam` — config + examples. -- `debian/`, `pam_tacplus.spec.in` — packaging. - -## Cross-repo context - -Authentication building block of the VyOS image. Provides the `libtac` library that `libnss-tacplus` links against, and the PAM module that `libtacplus-map` complements for `/etc/passwd`-less TACACS+ logins. Built via `VyOS-Networks/vyos-build-packages`; consumed by `vyos/vyos-build`. - -## Conventions - -- Default branch `master`. LTS branches when needed. -- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). -- Treat as upstream-vendored: minimise diffs against the upstream `pam_tacplus`. - -## Mirror relationship - -Mirror twin: `VyOS-Networks/libpam-tacplus`. Canonical side is here. Note that the VyOS-Networks side has its `git-actions` branch configured as default (audit observation §8.2 of relations doc) — that's not the canonical state. - -## Notes for future contributors - -- The `libtac/` subdirectory is the TACACS+ protocol library and is shipped as a separately versioned `libtac2` Debian package — bump the soname carefully. -- README is upstream's; VyOS-specific behaviour is encoded only by the build flags and patches applied here. |