labagent 0.1.0__tar.gz

labagent-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+- Fork, branch, open a PR. CI runs unit tests against mocked AWS (`moto`). It has no secrets and never touches real AWS.
+- Add a deleter: implement it in `labagent/deleters.py` (idempotent, returns `Result`), register it in `REGISTRY` with an order,
+  add an ARN parse case in `labagent/discovery.py` and a moto test.
+- Do not add organisation-specific values (account IDs, names, domains) to code or examples. Use `example.com` and `123456789012`.
+- Run `python scripts/check_no_pii.py` and `pytest` before pushing.
+- Changes under `labagent/`, `scripts/` and `.github/` need a maintainer review (see CODEOWNERS).
+
+## Releasing (maintainers)
+
+1. Bump `__version__` in `labagent/__init__.py` and update the changelog notes in the PR.
+2. Merge, then tag `vX.Y.Z` on `main`. The `release` workflow builds, runs `twine check --strict`, verifies the tag matches
+   the version and publishes to PyPI via Trusted Publishing (no tokens). Use the manual run with `testpypi` first for a dry run.
+3. One-time: on pypi.org add a (pending) publisher for `becloudready/labagent`, workflow `release.yml`, environment `pypi`.

labagent-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

labagent-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include LICENSE README.md SECURITY.md CONTRIBUTING.md
+recursive-include docs *.md *.yml *.json
+recursive-include examples *.json
+recursive-include scripts *.py
+recursive-include tests *.py
+recursive-include labagent/terraform *.tf *.tftpl *.hcl
+# never ship operational data or state
+global-exclude *.tfstate *.tfstate.* *.tfvars *.pem job*.json result*.json plan*.json lab.json *.pyc
+prune .venv
+prune build

labagent-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: labagent
+Version: 0.1.0
+Summary: Provision, audit and safely tear down ephemeral AWS sandboxes for workshops, bootcamps and shared training accounts.
+Author: BeCloudReady
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/becloudready/labagent
+Project-URL: Source, https://github.com/becloudready/labagent
+Project-URL: Issues, https://github.com/becloudready/labagent/issues
+Project-URL: Documentation, https://github.com/becloudready/labagent/tree/main/docs
+Keywords: aws,training,workshop,sandbox,cleanup,iam,terraform,finops,boto3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3>=1.34
+Requires-Dist: cryptography>=42
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: moto[all]>=5; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# labagent
+
+Provision, audit and **safely tear down** ephemeral AWS sandboxes for workshops, bootcamps and shared training accounts.
+
+```bash
+pip install labagent     # Python 3.9+; Terraform or OpenTofu >= 1.11 for the cohort IAM layer
+labagent --version
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `provision` | Terraform creates a cohort's IAM users, group, sandbox policy and Lambda role. Passwords are issued afterwards and returned **encrypted** to your public key, so state holds no secrets |
+| `inventory`, `sweep` | List and delete what learners created. Plan first, then apply exactly that reviewed plan |
+| `reset`, `offboard` | Rotate a learner's password; destroy a cohort (refuses while resources remain) |
+| `audit`, `cleanup` | Clean an untagged, long-lived account from an explicit **ruleset** ([docs](docs/account-cleanup.md)) |
+
+## Safety
+
+- Plan, then apply: the plan is bound to the account, its items, an age limit and the hash a human approved.
+- Only a `delete` rule can delete. `keep` rules always win; anything unmatched is reported, never removed.
+- Refuses to run in an account that is not on your allow-list. Re-running is always safe.
+- No plaintext secrets or emails in output or logs, and no PII in this repo (enforced by tests).
+
+## Use
+
+```bash
+cp examples/config.example.json lab.json     # set allowed_account_ids and the S3 state backend
+labagent --config lab.json run --job job.json --output result.json
+```
+
+Job and result formats: [docs/job-contract.md](docs/job-contract.md). State and secrets: [docs/state-and-secrets.md](docs/state-and-secrets.md).
+Run it from a **private** CI repo with GitHub OIDC (examples in [docs/examples](docs/examples)), never from a public one.
+Keep real configs, rosters, rulesets and job/result files out of this repo; `.gitignore` blocks the usual names.
+
+Early release (v0.1), tested against mocked AWS: try a throwaway account first. Apache-2.0; see [SECURITY.md](SECURITY.md) and [CONTRIBUTING.md](CONTRIBUTING.md).

labagent-0.1.0/README.md

@@ -0,0 +1,37 @@
+# labagent
+
+Provision, audit and **safely tear down** ephemeral AWS sandboxes for workshops, bootcamps and shared training accounts.
+
+```bash
+pip install labagent     # Python 3.9+; Terraform or OpenTofu >= 1.11 for the cohort IAM layer
+labagent --version
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `provision` | Terraform creates a cohort's IAM users, group, sandbox policy and Lambda role. Passwords are issued afterwards and returned **encrypted** to your public key, so state holds no secrets |
+| `inventory`, `sweep` | List and delete what learners created. Plan first, then apply exactly that reviewed plan |
+| `reset`, `offboard` | Rotate a learner's password; destroy a cohort (refuses while resources remain) |
+| `audit`, `cleanup` | Clean an untagged, long-lived account from an explicit **ruleset** ([docs](docs/account-cleanup.md)) |
+
+## Safety
+
+- Plan, then apply: the plan is bound to the account, its items, an age limit and the hash a human approved.
+- Only a `delete` rule can delete. `keep` rules always win; anything unmatched is reported, never removed.
+- Refuses to run in an account that is not on your allow-list. Re-running is always safe.
+- No plaintext secrets or emails in output or logs, and no PII in this repo (enforced by tests).
+
+## Use
+
+```bash
+cp examples/config.example.json lab.json     # set allowed_account_ids and the S3 state backend
+labagent --config lab.json run --job job.json --output result.json
+```
+
+Job and result formats: [docs/job-contract.md](docs/job-contract.md). State and secrets: [docs/state-and-secrets.md](docs/state-and-secrets.md).
+Run it from a **private** CI repo with GitHub OIDC (examples in [docs/examples](docs/examples)), never from a public one.
+Keep real configs, rosters, rulesets and job/result files out of this repo; `.gitignore` blocks the usual names.
+
+Early release (v0.1), tested against mocked AWS: try a throwaway account first. Apache-2.0; see [SECURITY.md](SECURITY.md) and [CONTRIBUTING.md](CONTRIBUTING.md).

labagent-0.1.0/SECURITY.md

@@ -0,0 +1,19 @@
+# Security
+
+`labagent` deletes cloud resources and handles credentials. Please report vulnerabilities privately through
+GitHub's "Report a vulnerability" (Security tab), not in a public issue.
+
+## Design guarantees (and how they are tested)
+
+- Destructive actions are plan-then-apply with an integrity hash (`tests/test_plan.py`, `tests/test_sweep_moto.py`).
+- Account allow-list is mandatory (`test_account_guard`, `test_empty_allowlist_refuses`).
+- Passwords are only emitted RSA-OAEP encrypted (`tests/test_iam_ops.py`) and never enter Terraform state (the module declares no login profile; `tests/test_tf_wrapper.py`).
+- State lives in a private, versioned, KMS-encrypted S3 bucket created by the packaged `state_backend` module (`labagent bootstrap-path`); no backend values are committed.
+- Logs contain no emails (`test_logs_contain_no_emails`). The repo contains no PII or secrets (`scripts/check_no_pii.py`).
+
+## Operating it safely
+
+- Run it from a private repo using GitHub OIDC (see `docs/examples/`). Never from a public repo: run logs are public.
+- Pin the commit you run (`LABAGENT_SHA`) and move the pin by reviewed PR.
+- Use a dedicated AWS account for labs. Use separate read-only and write roles.
+- Never commit rosters, credentials, Terraform state or job/result files. `.gitignore` blocks the common names.

labagent-0.1.0/docs/account-cleanup.md

@@ -0,0 +1,67 @@
+# Cleaning up an existing account
+
+For accounts that were never tagged consistently (shared accounts, years of workshop leftovers). The tag-driven cohort
+`sweep` cannot help there, because it only finds what carries your tag. `audit` and `cleanup` work from a **ruleset**:
+an explicit, reviewable statement of what may be deleted.
+
+## Safety model: delete only what a rule says
+
+Decision order for every discovered resource:
+
+1. a `keep` rule matches: **keep** (always wins, regardless of rule order)
+2. built-in protected name prefixes (CloudTrail, Config, CDK, ...): **keep**
+3. a `delete` rule matches **and** `labagent` has a deleter for the type: **delete**
+4. anything else: **review**. It is reported and never deleted.
+
+So a forgotten resource type or a typo makes labagent delete *less*, not more. Empty `match` blocks and `delete` rules
+without a type are rejected when the ruleset is loaded. A rule with `"enabled": false` stays in the file but has no effect.
+
+## Ruleset
+
+```json
+{
+  "version": 1, "name": "legacy-cleanup",
+  "rules": [
+    {"id": "keep-admin", "action": "keep",   "match": {"type": ["iam/user"], "name": ["admin_*"]}},
+    {"id": "old-keys",   "action": "delete", "match": {"type": ["ec2/key-pair"], "older_than_days": 30}}
+  ]
+}
+```
+
+Match keys (all must match; a list means any entry): `type` (`service/type`), `region`, `name` (glob, case-insensitive),
+`id`, `name_regex`, `tags` (`{"Key": "glob"}`), `tags_absent`, `older_than_days`, `unused_days`, `attrs` (exact match on
+discovered attributes such as `enabled`, `attachments`, `aliases`). See `labagent/rules.py` for the full contract and
+`examples/rulesets/legacy-cleanup.example.json` for a starting point.
+
+**Keep your real rulesets out of this public repo.** They contain your resource names. Store them in the private runner
+repo (or the orchestrator) and pass them to the job.
+
+## Workflow
+
+| Step | Command | Changes AWS? |
+|---|---|---|
+| 1. Audit | job `{"command":"audit","options":{"regions":["us-east-1"]}}` with your ruleset | no |
+| 2. Plan | `{"command":"cleanup","mode":"plan"}` | no. Returns a plan with an id and hash |
+| 3. Review | read `items`: `delete`, `keep`, `review`, each with the rule that decided it | no |
+| 4. Apply | `{"command":"cleanup","mode":"apply","plan":<plan>,"approved_hash":"<hash>"}` | yes: exactly the plan |
+| 5. Repeat | `pending` items (CloudFront, CloudFormation, throttled calls) return a `retry_after_s`. Re-run apply later | yes |
+| 6. Re-audit | step 1 again. Remaining `review` items become new rules, or stay | no |
+
+Locally: `labagent --config lab.json run --job job.json --ruleset rules.json --output result.json`.
+In CI: the same job through the private runner workflow (`docs/examples/runner-workflow.example.yml`); the orchestrator
+supplies the ruleset in the job.
+
+## Supported deleters
+
+CloudFormation stacks, CloudFront, API Gateway (REST, HTTP), Lambda, EC2 instances, Elastic IPs, volumes, key pairs,
+security groups, S3 (versions included), DynamoDB, CloudWatch log groups, SNS, SQS, Secrets Manager (7 day recovery),
+ECR (force), IAM users, groups, roles and policies (detached from everything first).
+
+Discovered but not deletable yet (reported as `review`, even if a rule matches): VPCs, NAT gateways, load balancers,
+RDS, EKS/ECS, KMS aliases, Route 53.
+
+## Order and dependencies
+
+Applied in dependency order: stacks, CloudFront, APIs, Lambda, EC2, key pairs, security groups, S3, DynamoDB,
+logs, messaging, secrets, ECR, then IAM users, groups, roles, policies. In-use resources return `pending` and a retry
+hint; they never fail the run.

labagent-0.1.0/docs/e2e-test-plan.md

@@ -0,0 +1,81 @@
+# End-to-end test plan: onboarding a cohort of 10
+
+Use a **throwaway or dedicated AWS account**, never the shared one. Cost: 10 IAM users are free; test resources cost cents.
+Put a $20 AWS Budget alarm on the account first.
+
+All fake data: `e2e-student-01..10@example.com`, cohort `e2e-001`, date `01-Jan-2030`.
+
+## Stage A: engine only (no GitHub, no LMS). About 2 hours. Can be done today.
+
+Setup
+```bash
+cd labagent && python3 -m venv .venv && .venv/bin/pip install -e ".[dev]" && source .venv/bin/activate
+cp examples/config.example.json lab.json        # set allowed_account_ids to the TEST account id; keep lab.json out of git
+export AWS_PROFILE=<admin profile for the test account>
+openssl genrsa -out priv.pem 2048 && openssl rsa -in priv.pem -pubout -out pub.pem
+```
+
+### A0: bootstrap the state backend (once per account)
+
+Follow `docs/state-and-secrets.md`: run the state backend module (`cd "$(labagent bootstrap-path)"`) with your own caller ARN in `admin_principal_arns` and
+`runner_principal_arns`, then copy `terraform output backend_config` into `lab.json` under `"backend"`.
+Also set `"name_prefix": "e2e"` so the test group, policy and role are `e2e-e2e-001-students` etc. and cannot collide with
+anything real. Terraform >= 1.11 must be installed (`terraform version`).
+
+| # | Action | Expected |
+|---|---|---|
+| A1 | `python scripts/make_test_job.py --command provision --mode dry-run --cohort e2e-001 --date 01-Jan-2030 --pubkey pub.pem > job.json`, then `labagent --config lab.json run --job job.json --output result.json` | exit 0, 10 items `planned` (a real `terraform plan`, read-only: no lock, no state write), nothing in IAM |
+| A2 | Same with no `--mode` (apply) | exit 0, 10 `created`, 10 `secrets` with ciphertext only. IAM shows 10 users, the cohort group, policy and Lambda role. S3 shows `cohorts/e2e-001/terraform.tfstate`: download it and confirm it contains **no password** |
+| A3 | Decrypt one: `jq -r '.secrets[0].ciphertext' result.json \| base64 -d > ct.bin; openssl pkeyutl -decrypt -inkey priv.pem -in ct.bin -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256 -pkeyopt rsa_mgf1_md:sha256` | prints a 20 char password. `grep` the result file for that password: no match |
+| A4 | Re-run A2 | 10 `exists`, **0 secrets** (no password re-issued), exit 0 |
+| A5 | Sign in to the console as student 01 with the decrypted password | forced to set a new password. Then: create an S3 bucket and a t3.micro EC2 (allowed); try us-west-2 (denied); try an m5.large (denied by the new instance-type rule, which is untested on real AWS) |
+| A6 | As students 01 and 02, create resources named `student-e2e-student-01-*`: a Lambda and an S3 bucket, tagged `workshop=full-stack`, `autodelete=true`, `date=01-Jan-2030`. Add: one tagged `autodelete=false`, one with **no tags**, and an Elastic IP tagged like the others | all created |
+| A7 | `make_test_job.py --command inventory ...` and run | per-learner counts for 01 and 02, the EIP present, untagged resource absent (known gap W4), exit 0 |
+| A8 | `--command sweep --mode plan`, run | read-only (nothing deleted). `items` show `delete` for tagged resources, `skip` with reason for the `autodelete=false` one. Save `result.json` |
+| A9 | Tamper: change one `skip` to `delete` in the plan, run `sweep --mode apply` | **refused**, exit 2, `plan hash mismatch`, nothing deleted |
+| A10 | Apply the untouched plan with `--approved-hash <plan.hash>` | tagged resources gone, `autodelete=false` and untagged remain, exit 0 |
+| A11 | Create a resource after the plan, apply the same plan again | the new resource survives (apply never rediscovers) |
+| A12 | `reset --learner-id 3` | new ciphertext, old password stops working |
+| A13 | Account guard: put a wrong id in `allowed_account_ids`, run any command | exit 2, refuses |
+| A14 | Leave one tagged resource, run `offboard` | **refused**. Sweep it, run `offboard` again | 10 users, the cohort group, policy and Lambda role deleted by `terraform destroy`; the state bucket remains |
+| A15 | Run offboard once more | exit 0, no changes (idempotent) |
+| A16 | Run two provision jobs at the same time for the same cohort | the second waits for the S3 lock (up to 5 min) or fails cleanly; state is not corrupted |
+
+CloudFront: create one distribution tagged as above, plan, apply, expect `pending` ("disabling"), re-run after about 15 to 30 minutes, expect `deleted`. REST API: create 3, expect throttled waits then `deleted` or `pending` with retry time.
+
+## Stage B: runner repo with a stand-in orchestrator. About half a day, needs lms-new L1 to L3.
+
+Prerequisites: private `labagent-runner` repo with `lab-job.yml` from `docs/examples/`, `config/lab.json`, the four repo variables; AWS OIDC provider and the two roles (trust policy pinned to repo and `main`); lms-new dev worker with the job and callback endpoints, the RSA private key, and a GitHub token limited to the runner repo.
+
+| # | Check | Expected |
+|---|---|---|
+| B1 | Dispatch a provision run from the Worker | workflow starts, fetches job, assumes the **write** role, posts result; run `success` |
+| B2 | Dispatch a sweep **plan** | assumes the **read** role (confirm in the run log) |
+| B3 | Fetch the same job twice | second fetch rejected |
+| B4 | Call the job endpoint with a token from a different repo or branch | rejected (`repository`, `ref` claims) |
+| B5 | Post the callback twice | second is a no-op (idempotent by run id) |
+| B6 | Dispatch two runs at once | they serialise (concurrency group) |
+| B7 | Read the run log and download any artifacts | **no emails, no passwords**, no artifacts; `job.json`/`result.json` removed |
+| B8 | Apply with a plan whose hash was not approved | refused |
+| B9 | Break `LABAGENT_SHA` to a wrong value | job fails before AWS is touched |
+
+## Stage C: the 10-student dashboard flow. About half a day, needs lms-new L4 to L10.
+
+1. Import 10 learners into a batch (bulk import).
+2. Create the lab environment, run **provision dry-run**, review, approve, apply.
+3. Each learner opens "My Lab": sees console URL and username, reveals the password **once**; a second reveal is blocked; the ciphertext is purged after the retention period.
+4. Three learners really sign in and deploy a project; one hits a problem and uses reset.
+5. Inventory view: per-learner counts, unattributed list.
+6. Environment end date: sweep plan appears for approval, admin approves, apply runs, pending CloudFront items are retried by the dashboard, then offboard.
+7. Audit log has one entry per action with actor and plan hash. Trainer role can view but not approve.
+
+## Pass criteria
+
+- Zero plaintext passwords anywhere (results, logs, artifacts, D1 rows).
+- Zero resources deleted that were not in the approved plan.
+- Account is clean afterwards: no users, no tagged resources, no Elastic IPs, no CloudFront.
+- Every step is re-runnable without harm.
+
+## Known gaps to expect
+
+Untagged resources are not found (W4); no cost report; ECR, NAT, load balancers and IAM roles are not swept.

labagent-0.1.0/docs/examples/oidc-trust-policy.example.json

@@ -0,0 +1,16 @@
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Principal": { "Federated": "arn:aws:iam::123456789012:oidc-provider/token.actions.githubusercontent.com" },
+      "Action": "sts:AssumeRoleWithWebIdentity",
+      "Condition": {
+        "StringEquals": {
+          "token.actions.githubusercontent.com:aud": "sts.amazonaws.com",
+          "token.actions.githubusercontent.com:sub": "repo:YOUR-ORG/YOUR-PRIVATE-RUNNER-REPO:ref:refs/heads/main"
+        }
+      }
+    }
+  ]
+}

labagent-0.1.0/docs/examples/permissions-read.example.json

@@ -0,0 +1,16 @@
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "ReadOnlyDiscovery",
+      "Effect": "Allow",
+      "Action": [
+        "sts:GetCallerIdentity",
+        "tag:GetResources",
+        "ec2:DescribeAddresses", "ec2:DescribeVolumes", "ec2:DescribeSecurityGroups", "ec2:DescribeInstances",
+        "cloudfront:GetDistribution", "cloudfront:GetDistributionConfig", "cloudfront:ListDistributions"
+      ],
+      "Resource": "*"
+    }
+  ]
+}

labagent-0.1.0/docs/examples/permissions-write.example.json

@@ -0,0 +1,41 @@
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "Discovery",
+      "Effect": "Allow",
+      "Action": ["sts:GetCallerIdentity", "tag:GetResources", "ec2:Describe*", "cloudfront:GetDistribution", "cloudfront:GetDistributionConfig"],
+      "Resource": "*"
+    },
+    {
+      "Sid": "DeleteLabResources",
+      "Effect": "Allow",
+      "Action": [
+        "lambda:DeleteFunction",
+        "s3:ListBucket", "s3:ListBucketVersions", "s3:DeleteObject", "s3:DeleteObjectVersion", "s3:DeleteBucket",
+        "dynamodb:DeleteTable",
+        "logs:DeleteLogGroup",
+        "ec2:TerminateInstances", "ec2:ReleaseAddress", "ec2:DisassociateAddress", "ec2:DeleteSecurityGroup", "ec2:DeleteVolume",
+        "apigateway:DELETE",
+        "cloudfront:UpdateDistribution", "cloudfront:DeleteDistribution"
+      ],
+      "Resource": "*"
+    },
+    {
+      "Sid": "CohortIamLifecycle",
+      "Effect": "Allow",
+      "Action": [
+        "iam:CreateUser", "iam:DeleteUser", "iam:GetUser", "iam:TagUser", "iam:ListUsers",
+        "iam:CreateLoginProfile", "iam:UpdateLoginProfile", "iam:DeleteLoginProfile",
+        "iam:ListAccessKeys", "iam:DeleteAccessKey", "iam:ListMFADevices", "iam:DeactivateMFADevice", "iam:DeleteVirtualMFADevice",
+        "iam:ListSigningCertificates", "iam:DeleteSigningCertificate", "iam:ListSSHPublicKeys", "iam:DeleteSSHPublicKey",
+        "iam:ListUserPolicies", "iam:DeleteUserPolicy", "iam:ListAttachedUserPolicies", "iam:DetachUserPolicy",
+        "iam:ListGroupsForUser", "iam:AddUserToGroup", "iam:RemoveUserFromGroup",
+        "iam:GetPolicy", "iam:GetPolicyVersion", "iam:CreatePolicy", "iam:CreatePolicyVersion", "iam:DeletePolicyVersion", "iam:ListPolicyVersions",
+        "iam:CreateGroup", "iam:AttachGroupPolicy",
+        "iam:CreateRole", "iam:AttachRolePolicy", "iam:PutRolePolicy", "iam:TagRole", "iam:TagPolicy"
+      ],
+      "Resource": "*"
+    }
+  ]
+}