From 8d695558773bf49947917aa3267f1cca480d8eb3 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 14:30:47 +0300 Subject: general: T8595: add AGENTS.md --- .github/copilot-instructions.md | 1 + AGENTS.md | 49 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 120000 .github/copilot-instructions.md create mode 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 120000 index 0000000..be77ac8 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +../AGENTS.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..e31de38 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,49 @@ +# AGENTS.md + +## Project purpose + +VyOS fork of the upstream `pam_radius_auth` PAM module — turns any host into a RADIUS client for authentication, password change, and (Linux-only) session accounting. Ships as the Debian source package `vyos-libpam-radius-auth`, plus a `vyos-radius-shell` companion package (shell front-end for RADIUS users). + +## Tech stack + +- C, GNU autotools (`configure.ac`, `Makefile`, `acinclude.m4`, `m4/`). +- Debian packaging in `debian/` (debhelper >= 12, `libpam0g-dev`, `libaudit-dev`, `libcap-dev`). +- License: GPL-2.0 (per `LICENSE`). + +## Build / test / run + +```sh +autoreconf -i # generate ./configure from configure.ac +./configure +make +dpkg-buildpackage -us -uc # produces vyos-libpam-radius-auth + vyos-radius-shell .debs +``` + +No in-tree test runner. Configuration lives at `pam_radius_auth.conf`; man pages at `pam_radius_auth.5`/`.8`, `radius_shell.8`. + +## Repository layout + +- `src/` — module source. +- `pam_radius_auth.conf`, `pam_radius_auth.5`/`.8` — config + manpages. +- `pamsymbols.ver` — symbol export map. +- `debian/`, `pam_radius_auth.spec` — Debian and RPM packaging. +- `Jenkinsfile` — legacy upstream CI (not used by VyOS pipeline). + +## Cross-repo context + +Authentication building block consumed by the VyOS image. Built by `VyOS-Networks/vyos-build-packages` and pulled into the ISO via `vyos/vyos-build`. Sibling auth repos: `libpam-tacplus`, `libnss-tacplus`, `libnss-mapuser`, `libtacplus-map`. Used by `vyos-1x` conf-mode scripts that wire `pam_radius` into `/etc/pam.d`. + +## Conventions + +- Default branch `current`; LTS branches `sagitta`/`circinus` when used. +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). +- Treat as upstream-vendored: keep diffs against the original `pam_radius` minimal; large feature work goes in VyOS-specific glue rather than this fork. + +## Mirror relationship + +Mirror twin: `VyOS-Networks/libpam-radius-auth`. Canonical side is here. Active workflows: `cla-check.yml`, `pr-mirror-repo-sync.yml` — mirror pipeline IS wired up; merges to `current` propagate to the VyOS-Networks twin. + +## Notes for future contributors + +- Renamed source/binary packages (`vyos-libpam-radius-auth`, `vyos-radius-shell`) on purpose — do not revert to upstream `libpam-radius-auth` package names without a coordinated change in `vyos-build-packages` and `vyos-1x` PAM templates. +- The `Jenkinsfile` is upstream cruft; VyOS CI runs through GitHub Actions reusables in `vyos/.github`. -- cgit v1.2.3 From a59c7d7a230367a52b42948db03ea6ab0d4c6f75 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:03:57 +0300 Subject: general: T8595: clean leaked internal references --- AGENTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index e31de38..1461a16 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -13,10 +13,10 @@ VyOS fork of the upstream `pam_radius_auth` PAM module — turns any host into a ## Build / test / run ```sh -autoreconf -i # generate ./configure from configure.ac +autoreconf -i # generate./configure from configure.ac ./configure make -dpkg-buildpackage -us -uc # produces vyos-libpam-radius-auth + vyos-radius-shell .debs +dpkg-buildpackage -us -uc # produces vyos-libpam-radius-auth + vyos-radius-shell.debs ``` No in-tree test runner. Configuration lives at `pam_radius_auth.conf`; man pages at `pam_radius_auth.5`/`.8`, `radius_shell.8`. -- cgit v1.2.3 From b54c25fad29fa252c9756c82ba62088dfd0a12b4 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:27:28 +0300 Subject: general: T8595: scrub private-org references from public AGENTS.md --- AGENTS.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1461a16..0742b59 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,7 +31,7 @@ No in-tree test runner. Configuration lives at `pam_radius_auth.conf`; man pages ## Cross-repo context -Authentication building block consumed by the VyOS image. Built by `VyOS-Networks/vyos-build-packages` and pulled into the ISO via `vyos/vyos-build`. Sibling auth repos: `libpam-tacplus`, `libnss-tacplus`, `libnss-mapuser`, `libtacplus-map`. Used by `vyos-1x` conf-mode scripts that wire `pam_radius` into `/etc/pam.d`. +Authentication building block consumed by the VyOS image. Built by the internal build-packages workflow and pulled into the ISO via `vyos/vyos-build`. Sibling auth repos: `libpam-tacplus`, `libnss-tacplus`, `libnss-mapuser`, `libtacplus-map`. Used by `vyos-1x` conf-mode scripts that wire `pam_radius` into `/etc/pam.d`. ## Conventions @@ -39,10 +39,6 @@ Authentication building block consumed by the VyOS image. Built by `VyOS-Network - Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). - Treat as upstream-vendored: keep diffs against the original `pam_radius` minimal; large feature work goes in VyOS-specific glue rather than this fork. -## Mirror relationship - -Mirror twin: `VyOS-Networks/libpam-radius-auth`. Canonical side is here. Active workflows: `cla-check.yml`, `pr-mirror-repo-sync.yml` — mirror pipeline IS wired up; merges to `current` propagate to the VyOS-Networks twin. - ## Notes for future contributors - Renamed source/binary packages (`vyos-libpam-radius-auth`, `vyos-radius-shell`) on purpose — do not revert to upstream `libpam-radius-auth` package names without a coordinated change in `vyos-build-packages` and `vyos-1x` PAM templates. -- cgit v1.2.3