Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ From here you will be able to select your preferred method of choice

### Frecency

Granted uses a [Frecency](https://en.wikipedia.org/wiki/Frecency) algorithm to show the most frequent and recent profiles at the top of the list when running `assume`. The algorithm can be found [here](https://github.com/common-fate/granted/blob/main/pkg/frecency/frecency.go). The algorithm caches frecency data locally in the `aws_profiles_frecency` file in the Granted configuration folder.
Granted uses a [Frecency](https://en.wikipedia.org/wiki/Frecency) algorithm to show the most frequent and recent profiles at the top of the list when running `assume`. The algorithm can be found [here](https://github.com/fwdcloudsec/granted/blob/main/pkg/frecency/frecency.go). The algorithm caches frecency data locally in the `aws_profiles_frecency` file in the Granted configuration folder.

## Autocompletion

Granted has support for shell auto complete. We currently support zsh and fish, with plans to support [bash, and powershell](https://github.com/urfave/cli/tree/master/autocomplete) in the future. Please let us know of your interest by [opening an issue on GitHub](https://github.com/common-fate/granted/issues).
Granted has support for shell auto complete. We currently support zsh and fish, with plans to support [bash, and powershell](https://github.com/urfave/cli/tree/master/autocomplete) in the future. Please let us know of your interest by [opening an issue on GitHub](https://github.com/fwdcloudsec/granted/issues).

### Fish

Expand Down
4 changes: 1 addition & 3 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ Granted is a command line interface (CLI) written in Go which uses the [AWS Go S

## Who was Granted created by?

Granted is created by [Chris Norman](https://cnorman.co) and the [Common Fate](https://commonfate.io) team. It is maintained by [fwd:cloudsec](https://fwdcloudsec.org), a non-profit organization dedicated to cloud security.
Granted was created by [Chris Norman](https://cnorman.co) and the [Common Fate](https://commonfate.io) team. It is maintained by [fwd:cloudsec](https://fwdcloudsec.org), a non-profit organization dedicated to cloud security.

## Is Granted free?

Yes! Granted is released as open source with an MIT licence. You are free to remix Granted and use it as part of your own internal CLI tools. You can find the source code to Granted on GitHub [here](https://github.com/fwdcloudsec/granted). Issues and Pull Requests are most welcome.

Common Fate is building tooling on top of Granted for identity workflows such as breakglass access and user access review evidence generation. This tooling is available as [Common Fate](https://commonfate.io) under a commercial licence. The Granted core CLI will always remain free and open source.

## What cloud providers does Granted work with?

Granted works with AWS.
2 changes: 1 addition & 1 deletion src/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ To verify that the installation has succeeded, print the version of Granted by r
Granted v0.39.0
```

If you have any issues installing don't hesitate to [ask for help on our Slack](https://join.slack.com/t/commonfatecommunity/shared_invite/zt-q4m96ypu-_gYlRWD3k5rIsaSsqP7QMg).
If you have any issues installing don't hesitate to [ask for help on our Slack](https://fwdcloudsec.org/forum/).

## Next steps

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/internals/different-assumers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ title: "How different Assumers work in Granted"

There are multiple ways to set up your AWS config file for authentication and access credentials.

Granted which is powered by [Go under the hood](https://github.com/common-fate/granted) uses an “Assumer” interface abstraction which can be customized for specific config profiles as per the requirement.
Granted which is powered by [Go under the hood](https://github.com/fwdcloudsec/granted) uses an “Assumer” interface abstraction which can be customized for specific config profiles as per the requirement.

[The Assumer Interface is implemented as:](https://github.com/common-fate/granted/blob/main/pkg/cfaws/assumers.go)
[The Assumer Interface is implemented as:](https://github.com/fwdcloudsec/granted/blob/main/pkg/cfaws/assumers.go)

```go

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/internals/shell-alias.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When opening a web console for your active role by running `assume -c -ar`, Gran

</Aside>

Shells such as Bash generally do not permit executables to export environment variables into the shell which called them. To overcome this limitation, Granted includes an `assume` [shell script](https://github.com/common-fate/granted/blob/main/scripts/assume) which wraps our binary (called `assumego`) and reads the `stdout` output of the binary. After assuming a role, our binary prints the following line to `stdout`:
Shells such as Bash generally do not permit executables to export environment variables into the shell which called them. To overcome this limitation, Granted includes an `assume` [shell script](https://github.com/fwdcloudsec/granted/blob/main/scripts/assume) which wraps our binary (called `assumego`) and reads the `stdout` output of the binary. After assuming a role, our binary prints the following line to `stdout`:

```
GrantedAssume <AWS_ACCESS_KEY_ID> <AWS_SECRET_ACCESS_KEY> <AWS_SESSION_TOKEN> <AWS_PROFILE>
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Granted is a command line interface (CLI) tool which simplifies access to cloud

## Supported cloud providers

Granted currently supports AWS. If you'd like to see support for another cloud provider please let us know by [opening an issue on GitHub](https://github.com/common-fate/granted/issues)!
Granted currently supports AWS. If you'd like to see support for another cloud provider please let us know by [opening an issue on GitHub](https://github.com/fwdcloudsec/granted/issues)!

On AWS, Granted works with both IAM roles and with AWS SSO. We highly recommend using Granted with AWS SSO as it avoids storing long-lived IAM credentials on your device.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/recipes/automatically_reassume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export GRANTED_ENABLE_AUTO_REASSUME=true
`GRANTED_ENABLE_AUTO_REASSUME` because AWS will automatically call the granted
credential process as needed to refresh your session credentials. As we have
updated our code from
[v0.19.0](https://github.com/common-fate/granted/releases/tag/v0.19.0) to
[v0.19.0](https://github.com/fwdcloudsec/granted/releases/tag/v0.19.0) to
export only the `AWS_PROFILE` environment variable when using credential
process.
</Aside>
2 changes: 1 addition & 1 deletion src/content/docs/recipes/credential-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ You can now add `granted_sso_registration_scopes = sso:account:access` to your `
granted_sso_account_id = 123456789012
granted_sso_role_name = AWSAdministratorAccess
granted_sso_registration_scopes = sso:account:access
granted_sso_start_url = https://commonfate.awsapps.com/start
granted_sso_start_url = https://fwdcloudsec.awsapps.com/start
granted_sso_region = ap-southeast-2
credential_process = granted credential-process --profile example
```
2 changes: 1 addition & 1 deletion src/content/docs/recipes/eks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Where `<PROFILE_NAME>` is the name of the AWS profile to use, `<CLUSTER_REGION>`
<Aside>
If you are utilizing version v0.20.3 or an earlier release, the `command`
should be `assumego` instead of `assume` due to the
[changes](https://github.com/common-fate/granted/pull/549) introduced in
[changes](https://github.com/fwdcloudsec/granted/pull/549) introduced in
v0.20.4 which modifies the behavior of assumego.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/recipes/ubuntu-keyring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Open the Granted configuration file located at `~/.granted/config`. Add the foll

Next time you run Granted, it will use the `secret-service` backend to store AWS SSO tokens and it will not ask you to enter your password. It will unlock it with the `login` keychain instead.

To learn more about how to configure the keyring, check out [these settings](https://github.com/common-fate/granted/blob/bcf79899f282cceff6313f1757d963e4dbbf44e1/pkg/config/config.go#L58-L63) that are exposed in Granted and the upstream [library documentation](https://pkg.go.dev/github.com/99designs/keyring?utm_source=godoc) for further details.
To learn more about how to configure the keyring, check out [these settings](https://github.com/fwdcloudsec/granted/blob/bcf79899f282cceff6313f1757d963e4dbbf44e1/pkg/config/config.go#L58-L63) that are exposed in Granted and the upstream [library documentation](https://pkg.go.dev/github.com/99designs/keyring?utm_source=godoc) for further details.
2 changes: 1 addition & 1 deletion src/content/docs/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The permissions that this extension requires are:
| tabs | required to open a new tab in a container |
| storage | required to store information on the list of available containers |

Additionally, the source code for the addon is [available on GitHub under the MIT licence](https://github.com/common-fate/granted-containers). Security-conscious users may opt to build the extension from source and install it locally: instructions on how to do so are available in the GitHub repository.
Additionally, the source code for the addon is [available on GitHub under the MIT licence](https://github.com/fwdcloudsec/granted-containers). Security-conscious users may opt to build the extension from source and install it locally: instructions on how to do so are available in the GitHub repository.

## Vulnerability Reporting

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/usage/assuming-roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Here is the current list of providers that work with Granted:
- [aws-google-auth](https://github.com/cevoaustralia/aws-google-auth)
- Specifying a credential-process in your config

We are looking to add more to this list in the future. Contributions for additional credential providers are most welcome. If you're looking for a model example in our source code, [assumer_aws_azure_login.go](https://github.com/common-fate/granted/blob/eb7221d4e69472bf1c8a7171d930ff0cab37290d/pkg/cfaws/assumer_aws_azure_login.go) is a good starting point.
We are looking to add more to this list in the future. Contributions for additional credential providers are most welcome. If you're looking for a model example in our source code, [assumer_aws_azure_login.go](https://github.com/fwdcloudsec/granted/blob/eb7221d4e69472bf1c8a7171d930ff0cab37290d/pkg/cfaws/assumer_aws_azure_login.go) is a good starting point.

## Pass-through flags

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/usage/automatic-config-generation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ commonfate_generated_by = aws-sso

## Sources

Granted supports the below profile sources, using the `--source` flag. We'd love to hear from you if you have any suggestions for additional profile sources for us to add - you can [raise an issue here](https://github.com/common-fate/granted/issues/new). Multiple sources can be provided by specifying `--source` more than once when running a command.
Granted supports the below profile sources, using the `--source` flag. We'd love to hear from you if you have any suggestions for additional profile sources for us to add - you can [raise an issue here](https://github.com/fwdcloudsec/granted/issues/new). Multiple sources can be provided by specifying `--source` more than once when running a command.

| Source | CLI flag | Description |
| --------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/usage/browser-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To install the extension, follow the links below:
The Granted Chrome Extension and the Granted Firefox Add-On are open source under an MIT licence:

- [Granted Chrome Extension source code](https://github.com/common-fate/granted-browser-extension)
- [Granted Firefox Add-On source code](https://github.com/common-fate/granted-containers)
- [Granted Firefox Add-On source code](https://github.com/fwdcloudsec/granted-containers)

You can build the extension from source by following the documentation in the GitHub repositories for the extensions.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/usage/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ You can open a console and go directly to a specific service by adding the `--se
assume -s iam
```

Will open a console and take you directly to the IAM service (https://console.aws.amazon.com/iamv2). Granted supports using shortcuts such as `l` for the Lambda service. You can see the full list of shortcuts [here](https://github.com/common-fate/granted/blob/main/pkg/console/service_map.go). PRs which add additional shortcuts or services are very welcome.
Will open a console and take you directly to the IAM service (https://console.aws.amazon.com/iamv2). Granted supports using shortcuts such as `l` for the Lambda service. You can see the full list of shortcuts [here](https://github.com/fwdcloudsec/granted/blob/main/pkg/console/service_map.go). PRs which add additional shortcuts or services are very welcome.

## Opening the console with a specific destination

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/usage/profile-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ This will display all repositories subscribed to Granted's Profile Registry and

## Migrating Profile Registry configuration

As part of [Granted v0.5.0](https://github.com/common-fate/granted/releases/tag/v0.5.0), the Profile Registry didn't require the `-n` or `-u` flags. [Granted v0.6.0](https://github.com/common-fate/granted/releases/tag/v0.6.0) includes breaking changes to this. If you are using a version of Profile Registries prior to Granted v0.6.0, run the following command to migrate your registry configuration:
As part of [Granted v0.5.0](https://github.com/fwdcloudsec/granted/releases/tag/v0.5.0), the Profile Registry didn't require the `-n` or `-u` flags. [Granted v0.6.0](https://github.com/fwdcloudsec/granted/releases/tag/v0.6.0) includes breaking changes to this. If you are using a version of Profile Registries prior to Granted v0.6.0, run the following command to migrate your registry configuration:

```
granted registry migrate
Expand Down