Skip to content

Commit affc310

Browse files
author
Travis McPeak
committed
Initial commit
0 parents  commit affc310

File tree

14 files changed

+1544
-0
lines changed

14 files changed

+1544
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.pyc
2+
.DS_Store
3+
.DS_Store?
4+

AUTHORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- Patrick Kelley <[email protected]>
2+
- Travis McPeak <[email protected]>

LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2014 Netflix, Inc.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

OSSMETADATA

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
osslifecycle=active

README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Repokid #
2+
3+
Repokid uses Access Advisor provided by [Aardvark](https://github.com/Netflix-Skunkworks/aardvark)
4+
to remove permissions granting access to unused services from the inline policies of IAM roles in
5+
an AWS account.
6+
7+
## Getting Started
8+
9+
To use Repokid you will need:
10+
- A [DynamoDB](https://aws.amazon.com/dynamodb/) table called `repokid_roles` (specify account and endpoint in `dynamo_db` in config file)
11+
12+
- An IAM role with the following permissions (specified in `connection_iam` in config file):
13+
```{
14+
"Version": "2012-10-17",
15+
"Statement": [
16+
{
17+
"Sid": "Stmt1495554068860",
18+
"Action": [
19+
"iam:DeleteInstanceProfile",
20+
"iam:DeleteRole",
21+
"iam:DeleteRolePolicy",
22+
"iam:GetInstanceProfile",
23+
"iam:GetRole",
24+
"iam:GetRolePolicy",
25+
"iam:ListInstanceProfiles",
26+
"iam:ListInstanceProfilesForRole",
27+
"iam:ListRolePolicies",
28+
"iam:ListRoles",
29+
"iam:PutRolePolicy"
30+
],
31+
"Effect": "Allow",
32+
"Resource": "*"
33+
}
34+
]
35+
}
36+
```
37+
38+
- An IAM role with DyamoDB permissions for the `repokid_roles` table and all indexes (specified in `assume_role` subsection of `dynamo_db` in config)
39+
40+
## Optional Config
41+
Repokid uses filters to decide which roles are candidates to be repoed. Filters may be configured to suit your
42+
environment as described below.
43+
44+
### Blacklist Filter
45+
Roles may be excluded by adding them to the Blacklist filter. One common reason to exclude a role is if
46+
the corresponding workload performs occasional actions that may not have been observed but are known to be
47+
required. There are two ways to exclude a role:
48+
49+
- Exclude role name for all accounts: add it to a list in the config `filter_config.BlacklistFilter.all`
50+
- Exclude role name for specific account: add it to a list in the config `filter_config.BlacklistFilter.<ACCOUNT_NUMBER>`
51+
52+
### Age Filter
53+
By default the age filter excludes roles that are younger than 90 days. To change this edit the config setting:
54+
`filter_config.AgeFilter.minimum_age`.
55+
56+
### Active Filters
57+
New filters can be created to support internal logic. At Netflix we have several that are specific to our
58+
use cases. To make them active make sure they are in the Python path and add them in the config to the list in
59+
the section `active_filters`.
60+
61+
## How to Use
62+
Once Repokid is configured use it as follows:
63+
64+
### Standard flow
65+
- Update role cache: `repokid update_role_cache <ACCOUNT_NUMBER>`
66+
- Display role cache: `repokid display_role_cache <ACCOUNT_NUMBER>`
67+
- Display information about a specific role: `repokid display_role <ACCOUNT_NUMBER> <ROLE_NAME>`
68+
- Repo a specific role: `repokid repo_role <ACCOUNT_NUMBER> <ROLE_NAME>`
69+
- Repo all roles in an account: `repokid repo_all_roles <ACCOUNT_NUMBER> -c`
70+
71+
### Rolling back
72+
Repokid stores a copy of each version of inline policies it knows about. These are added when
73+
a different version of a policy is found during `update_role_cache` and any time a repo action
74+
occurs. To restore a previous version run:
75+
76+
See all versions of roles: `repokid rollback_role <ACCOUNT_NUMBER> <ROLE_NAME>`
77+
Restore a specific version: `repokid rollback_role <ACCOUNT_NUMBER> <ROLE_NAME> --selection=<NUMBER> -c`
78+
79+
### Stats
80+
Repokid keeps counts of the total permissions for each role. Stats are added any time an `update_role_cache` or
81+
`repo_role` action occur. To output all stats to a CSV file run: `repokid repo_stats <OUTPUT_FILENAME>`. An optional account number can be specified to output stats for a specific account only.
82+
83+
## Developing locally
84+
You can run a DynamoDB development server locally by [downloading it](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)
85+
86+
To run:
87+
`java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb -inMemory -port 8010`
88+
89+
## TODO
90+
[TODO](TODO.md)

repokid/__init__.py

Whitespace-only changes.

repokid/filters/__init__.py

Whitespace-only changes.

repokid/filters/age/__init__.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import datetime
2+
from dateutil.tz import tzlocal
3+
from repokid.repokid import Filter
4+
from repokid.repokid import LOGGER
5+
6+
7+
class AgeFilter(Filter):
8+
def apply(self, input_list):
9+
now = datetime.datetime.now(tzlocal())
10+
try:
11+
days_delta = self.config['minimum_age']
12+
except KeyError:
13+
LOGGER.info('Minimum age not set in config, using default 90 days')
14+
days_delta = 90
15+
16+
ago = datetime.timedelta(days=days_delta)
17+
18+
too_young = []
19+
for role in input_list:
20+
if role['CreateDate'] > now - ago:
21+
LOGGER.info('Role {name} created too recently to cleanup. ({date})'.format(
22+
name=role['RoleName'], date=role['CreateDate']))
23+
too_young.append(role)
24+
return too_young

repokid/filters/blacklist/__init__.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
from repokid.repokid import Filter
2+
from repokid.repokid import CUR_ACCOUNT_NUMBER
3+
from repokid.repokid import LOGGER
4+
5+
6+
class BlacklistFilter(Filter):
7+
def __init__(self, config=None):
8+
self.config = config
9+
10+
overridden_role_names = set()
11+
overridden_role_names.update([rolename.lower() for rolename in config.get(CUR_ACCOUNT_NUMBER, [])])
12+
overridden_role_names.update([rolename.lower() for rolename in config.get('all', [])])
13+
self.overridden_role_names = overridden_role_names
14+
15+
def apply(self, input_list):
16+
blacklisted_roles = []
17+
for role in input_list:
18+
if role['RoleName'].lower() in self.overridden_role_names:
19+
blacklisted_roles.append(role)
20+
LOGGER.info('{name} in the role blacklist'.format(name=role['RoleName']))
21+
return blacklisted_roles

repokid/filters/lambda/__init__.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
from repokid.repokid import Filter
2+
from repokid.repokid import LOGGER
3+
4+
5+
class LambdaFilter(Filter):
6+
def apply(self, input_list):
7+
lambda_roles = []
8+
9+
for role in input_list:
10+
if 'lambda' in str(role['AssumeRolePolicyDocument']).lower():
11+
LOGGER.info('{name} looks like a lambda role.'.format(name=role['RoleName']))
12+
lambda_roles.append(role)
13+
return list(lambda_roles)

0 commit comments

Comments
 (0)