Skip to content

Commit

Permalink
Inspection Fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Geoffrey Wiseman <geoffrey.wiseman@codiform.com>
  • Loading branch information
geoffreywiseman committed Jun 16, 2023
1 parent 3a7d8d4 commit 2b9a3f3
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
# a pull request then we can check out the head.
fetch-depth: 2

# If this run was triggered by a pull request event, then checkout
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [1.1.0] - Unreleaed

### Added
- `--sg-name` option to let you modify a security group by unique name (including wildcards)

## [1.0.1] - 2018-05-08

### Changed
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you want usage help at the command line, try:
awswl --help
```

There's more detailed usage documentation in the documentation, which you can read on [github](docs/usage.md) or [readthedocs](https://awswl.readthedocs.io/en/latest/usage/).
There's more detailed usage documentation in the documentation, which you can read on [GitHub](docs/usage.md) or [readthedocs](https://awswl.readthedocs.io/en/latest/usage/).


## Environment
Expand Down
4 changes: 2 additions & 2 deletions docs/alternatives.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ AWS has a feature, [Session Manager](https://docs.aws.amazon.com/systems-manager

## AWS Site-to-Site VPN

If you're working from an office or a set of offices and you have good networking equipment and networking personnel, it's more common to use an [AWS site-to-site VPN](https://docs.aws.amazon.com/vpn/index.html), allowing you to connect the internal network of your office(s) to the internal network of your VPC(s).
If you're working from an office or a set of offices, and you have good networking equipment and networking personnel, it's more common to use an [AWS site-to-site VPN](https://docs.aws.amazon.com/vpn/index.html), allowing you to connect the internal network of your office(s) to the internal network of your VPC(s).

In a more complex environment, you might also include something like a Transit Gateway.

Expand All @@ -20,4 +20,4 @@ Some people prefer different VPN solutions and install OpenVPN appliances or a c

This is not an exhaustive list -- there are lots of other choices: Teleport, Direct Connect and probably a bunch of choices I haven't considered.

If you feel strongly about an alternative and you want to add it to the documentation, feel free to raise a PR.
If you feel strongly about an alternative, and you want to add it to the documentation, feel free to raise a PR.
2 changes: 1 addition & 1 deletion docs/edgecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Similarly, if what you've asked for requires a complex modification of a rule, A

If you ask AWSWL to revoke permissions on a CIDR block that is narrower than the authorization, you aren't likely to get the desired result. For instance, if you authorize `192.168.0.0/16` and then revoke `192.168.0.0/24` you could argue that the result should be that `192.168.1.0/24` all the way through `192.168.255.0/24` remain authorized and that `192.168.0.0/24` will be rejected, but that's definitely not what will happen.

AWSLWL also can't modify a permission block that includes a bunch of ports, including SSH.
AWSWL also can't modify a permission block that includes a bunch of ports, including SSH.

To be honest, I am not sure that it makes a lot of sense to address those issues so that it can modify rules like that, but I would prefer it to notice when situations like that are present and warn about the rules that it didn't modify -- essentially, I'd like it to validate a bit better.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In case you're encountering AWSWL without having considered the other options, y

## Project Name

I named this project when "whitelist" was the traditional and most common word for this sort of thing. In the interim, there's been some good progress on more inclusive language and now I'd say that "allowlist" is both preferred and more clear.
I named this project when "whitelist" was the traditional and most common word for this sort of thing. In the interim, there's been some good progress on more inclusive language, and now I'd say that "allowlist" is both preferred and more clear.

Renaming the pypy package and cli command will break links, so for now I'm referring to it as "allowlist" even though the repository and cli are named `awswl` instead of `awsal`.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ AWS AllowList is built in Python using boto, which can use an AWS Credentials fi

Boto's support for environment variables works fine with `aws-vault` and likely other similar tools. If you've tested `awswl` with a different aws authentication approach, let me know and I can list it here.

There's no attempt to capture or record credentials -- the awsal code doesn't actually interact with the credentials at all, that's all done by `boto`, but do feel free to look over the source to assuage any privacy concerns.
There's no attempt to capture or record credentials -- the awswl code doesn't actually interact with the credentials at all, that's all done by `boto`, but do feel free to look over the source to assuage any privacy concerns.

### AWS Region

Expand All @@ -90,7 +90,7 @@ If you want to modify a port other than the default SSH port, you can specify th

In order to get your current ip address, ``--list``, ``--add-current`` and ``--remove-current`` will make a request to ``checkip.amazonaws.org``. Because it's another AWS service, seems less likely to be a privacy concern for anyone.

I may [add a switch](https://github.com/geoffreywiseman/awswl/issues/3) to disable that for the anyone who isn't fond of `awswl` making an additional network request, so if that's a concern for you, feel free to vote for it.
I may [add a switch](https://github.com/geoffreywiseman/awswl/issues/3) to disable that for anyone who isn't fond of `awswl` making an additional network request, so if that's a concern for you, feel free to vote for it.

## Help and Version

Expand Down

0 comments on commit 2b9a3f3

Please sign in to comment.