@kensio/yulin 1.20.14 → 1.20.16

package/docs/services/sts/README.md

@@ -0,0 +1,245 @@
+# Simulated STS
+
+Yulin includes a simulated STS (Security Token Service) for tests and local development.
+
+Sim STS is used through `SimAws` as `simAws.sts()`, scoped to the Account making the assume request.
+It simulates assuming IAM Roles. An assume request is evaluated against
+[simulated IAM](https://yulinsim.dev/services/iam/) policies, and a request that passes issues temporary session credentials
+that the rest of the simulated environment authenticates like real AWS credentials.
+
+## Basic usage
+
+Create a Role whose trust policy allows the Account to assume it, then assume it through STS. An
+omitted caller defaults to the Account root principal.
+
+```typescript sim-sts-assume-role
+/**
+ * Assuming a simulated IAM Role through simulated STS.
+ */
+
+import { CreateRoleCommand } from "@aws-sdk/client-iam";
+import { AssumeRoleCommand } from "@aws-sdk/client-sts";
+import { SimAws } from "@kensio/yulin";
+
+const simAws = new SimAws();
+const account = simAws.account("123456789012");
+
+await account.iam().createRole(
+  new CreateRoleCommand({
+    RoleName: "TargetRole",
+    AssumeRolePolicyDocument: JSON.stringify({
+      Version: "2012-10-17",
+      Statement: {
+        Effect: "Allow",
+        Principal: { AWS: "arn:aws:iam::123456789012:root" },
+        Action: "sts:AssumeRole",
+      },
+    }),
+  }),
+);
+
+const assumeRoleOutput = await account.sts().assumeRole(
+  new AssumeRoleCommand({
+    RoleArn: "arn:aws:iam::123456789012:role/TargetRole",
+    RoleSessionName: "test-session",
+  }),
+);
+
+console.log(assumeRoleOutput.AssumedRoleUser?.Arn);
+console.log(assumeRoleOutput.Credentials?.AccessKeyId);
+console.log(assumeRoleOutput.Credentials?.Expiration);
+```
+
+The output matches the AWS shape. `AssumedRoleUser.Arn` is the session ARN, such as
+`arn:aws:sts::123456789012:assumed-role/TargetRole/test-session`, and `Credentials` carries the
+temporary `AccessKeyId`, `SecretAccessKey`, `SessionToken`, and `Expiration`.
+
+The issued credentials are registered with the target Account's sim IAM. They authenticate later
+simulated requests, for example as the `caller` of an IAM authorization attempt, where identity
+policies come from the underlying Role. See [the sim IAM docs](https://yulinsim.dev/services/iam/#sts-assumerole-sessions) for a
+full example. Credentials missing their session token, or used after `Expiration`, are rejected with
+an AWS-like invalid-credentials error.
+
+`DurationSeconds` controls the session lifetime and defaults to 3600 seconds (one hour). It must be
+a positive integer.
+
+## Role-to-Role assumption
+
+Pass a caller to assume a Role as a specific principal. As in real AWS, both sides of the request
+are then evaluated:
+
+- The target Role's trust policy must allow the caller to perform `sts:AssumeRole`
+- A non-root caller also needs an identity policy allowing `sts:AssumeRole` on the target Role's
+  ARN
+
+```typescript sim-sts-role-to-role
+/**
+ * One simulated IAM Role assuming another through simulated STS.
+ */
+
+import { CreateRoleCommand, PutRolePolicyCommand } from "@aws-sdk/client-iam";
+import { AssumeRoleCommand } from "@aws-sdk/client-sts";
+import { SimAws } from "@kensio/yulin";
+
+const simAws = new SimAws();
+const account = simAws.account("123456789012");
+const simIam = account.iam();
+
+const sourceRoleArn = "arn:aws:iam::123456789012:role/SourceRole";
+const targetRoleArn = "arn:aws:iam::123456789012:role/TargetRole";
+
+await simIam.createRole(
+  new CreateRoleCommand({
+    RoleName: "SourceRole",
+    AssumeRolePolicyDocument: JSON.stringify({
+      Version: "2012-10-17",
+      Statement: {
+        Effect: "Allow",
+        Principal: { AWS: "arn:aws:iam::123456789012:root" },
+        Action: "sts:AssumeRole",
+      },
+    }),
+  }),
+);
+
+await simIam.putRolePolicy(
+  new PutRolePolicyCommand({
+    RoleName: "SourceRole",
+    PolicyName: "AssumeTargetRole",
+    PolicyDocument: JSON.stringify({
+      Version: "2012-10-17",
+      Statement: {
+        Effect: "Allow",
+        Action: "sts:AssumeRole",
+        Resource: targetRoleArn,
+      },
+    }),
+  }),
+);
+
+await simIam.createRole(
+  new CreateRoleCommand({
+    RoleName: "TargetRole",
+    AssumeRolePolicyDocument: JSON.stringify({
+      Version: "2012-10-17",
+      Statement: {
+        Effect: "Allow",
+        Principal: { AWS: sourceRoleArn },
+        Action: "sts:AssumeRole",
+      },
+    }),
+  }),
+);
+
+const assumeRoleOutput = await account.sts().assumeRole(
+  new AssumeRoleCommand({
+    RoleArn: targetRoleArn,
+    RoleSessionName: "role-session",
+  }),
+  {
+    caller: { kind: "arn", arn: sourceRoleArn },
+  },
+);
+
+console.log(assumeRoleOutput.AssumedRoleUser?.Arn);
+```
+
+STS throws an AWS-like access-denied error if either side denies the request, which happens when the
+trust policy does not cover the caller, the caller has no identity policy allowing `sts:AssumeRole`,
+or an explicit `Deny` matches. The error has a `403` status code and names the `sts:AssumeRole`
+action and the target Role ARN. No session is created.
+
+Cross-Account assumption works the same way. Create the source and target Roles in different
+simulated Accounts of the same `SimAws` instance, and call `assumeRole` on the source Account's
+`sts()`. The issued session belongs to the target Role's Account.
+
+## Role chaining
+
+A process that assumes a Role and then assumes a second one from that session is chaining Roles. The
+caller of the second request is the session, and the Role it holds the permissions of is what both
+sides of the decision are written against. The trust policy of the target names that Role, and the
+identity policy allowing `sts:AssumeRole` belongs to it.
+
+Both ARNs of a session are matched against a `Principal`, so a trust policy naming either the Role
+or one particular session admits it. AWS recommends naming the Role, and a session name is often
+decided at run time rather than written into a policy.
+
+Chaining over a served endpoint works the same way. Credentials from the first request sign the
+second, and the caller they resolve to carries the Role along with the session.
+
+## ExternalId
+
+A trust policy can require an external ID through the `sts:ExternalId` condition key. The
+`ExternalId` supplied to `AssumeRoleCommand` is matched against it.
+
+```typescript sim-sts-external-id
+/**
+ * Requiring an ExternalId in a simulated Role trust policy.
+ */
+
+import { CreateRoleCommand } from "@aws-sdk/client-iam";
+import { AssumeRoleCommand } from "@aws-sdk/client-sts";
+import { SimAws } from "@kensio/yulin";
+
+const simAws = new SimAws();
+const account = simAws.account("123456789012");
+
+await account.iam().createRole(
+  new CreateRoleCommand({
+    RoleName: "PartnerRole",
+    AssumeRolePolicyDocument: JSON.stringify({
+      Version: "2012-10-17",
+      Statement: {
+        Effect: "Allow",
+        Principal: { AWS: "arn:aws:iam::123456789012:root" },
+        Action: "sts:AssumeRole",
+        Condition: {
+          StringEquals: {
+            "sts:ExternalId": "expected-external-id",
+          },
+        },
+      },
+    }),
+  }),
+);
+
+const assumeRoleOutput = await account.sts().assumeRole(
+  new AssumeRoleCommand({
+    RoleArn: "arn:aws:iam::123456789012:role/PartnerRole",
+    RoleSessionName: "partner-session",
+    ExternalId: "expected-external-id",
+  }),
+);
+
+console.log(assumeRoleOutput.AssumedRoleUser?.Arn);
+```
+
+An omitted or mismatched `ExternalId` leaves the trust-policy condition unmatched. The assume
+request is denied.
+
+## Available functionality
+
+Sim STS currently supports:
+
+- `AssumeRoleCommand`
+- Trust-policy evaluation against the target Role's assume-role policy document
+- Identity-policy evaluation of the source caller, requiring `sts:AssumeRole` permission on the
+  target Role
+- Role-to-Role and cross-Account assumption
+- `ExternalId` matching through the `sts:ExternalId` trust-policy condition key
+- Session duration with `DurationSeconds`, defaulting to one hour
+- Temporary credentials registered with the target Account's sim IAM, including session-token and
+  expiry validation
+
+Unsupported STS options may be ignored or may throw errors depending on whether the simulator needs
+them to model the requested behaviour.
+
+## Limitations
+
+Sim STS models Role assumption. Notable gaps:
+
+- `AssumeRoleCommand` is the only supported command. There is no `GetCallerIdentity`, federation, or
+  web-identity support
+- Session policies (`Policy` / `PolicyArns`), tags, and `SourceIdentity` requests are not evaluated
+- Condition support in trust policies is limited to the operators supported by
+  [sim IAM](https://yulinsim.dev/services/iam/#policy-conditions)