Skip to content

Commit

Permalink
ENG-13510: Add project documentation (#25)
Browse files Browse the repository at this point in the history 
* Add project documentation

* Update LICENSE

* Update LICENSE

* Address comments

---------

Co-authored-by: Wilson de Carvalho <[email protected]>
  • Loading branch information
@VictorGFM @wcmjunior
VictorGFM and wcmjunior authored Feb 20, 2024
1 parent 72bf444 commit 387b581
Show file tree
Hide file tree
Showing 2 changed files with 141 additions and 198 deletions.
211 changes: 15 additions & 196 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,201 +1,20 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
The Software is provided to you by the Licensor under the License, as defined
below, subject to the following condition.

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
Without limiting other conditions in the License, the grant of rights under the
License will not include, and the License does not grant to you, the right to
Sell the Software.

1. Definitions.
For purposes of the foregoing, “Sell” means practicing any or all of the rights
granted to you under the License to provide to third parties, for a fee or other
consideration (including without limitation fees for hosting or consulting/
support services related to the Software), a product or service whose value
derives, entirely or substantially, from the functionality of the Software. Any
license notice or attribution required by the License must also include this
Commons Clause License Condition notice.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
Software: DMAP

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
License: Apache 2.0

"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 2024 Cyral Inc.

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.
Licensor: Cyral, Inc.
128 changes: 126 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,127 @@
# dmap
# Dmap

DMap, by [Cyral](https://www.cyral.com).
<div align="center">
<img src="https://dmap-prod-public-dmap.s3.amazonaws.com/dmap-logo.svg">
</div>

Dmap is a free and open-source tool to assess your data security posture in AWS.
It allows you to quickly find information about your data repositories from
different AWS account environments, across multiple regions.

It currently supports different data repository types from across AWS services,
including:
- Amazon RDS (MySQL, PostgreSQL, SQL Server, etc)
- RDS Clusters (Aurora, Multi-AZ Clusters)
- Redshift
- DynamoDB
- DocumentDB

## Usage

### Requirements

The Dmap library requires a set of read-only AWS service permissions, so that
it's able to find existing data repositories from these services. IAM credentials
with permissions for the following actions are required:

- `rds:DescribeDBClusters`
- `rds:DescribeDBInstances`
- `rds:ListTagsForResource`
- `redshift:DescribeClusters`
- `dynamodb:DescribeTable`
- `dynamodb:ListTables`
- `dynamodb:ListTagsOfResource`

Make sure to use proper AWS credentials that contain the permissions above.

### Import

To import the Dmap library into your project, use the `go get` command below:
```go
go get github.com/cyralinc/dmap
```

### Scan

To use the Dmap library to find information about your existing data repositories,
follow the steps below:

1. Define the AWS credentials for the account to be scanned. This can be done
through one of the following options:
* Using credentials defined through AWS environment variables.
* Using the `default` profile from the AWS credentials file.
* Assuming an AWS IAM Role.

If you want to use an IAM Role, follow the instructions below on how to
configure the `ScannerConfig` to assume an IAM role. For more details, see the
AWS official guide on [Specifying Credentials](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).
2. Define the `ScannerConfig`.
1. Define the AWS regions to be scanned.
2. (Optional) Define the `AssumeRoleConfig` parameters for the IAM Role to
be assumed. The AWS default external configurations will be used instead
if this is not defined.
3. Instantiate a new `AWSScanner` using the `NewAWSScanner` function with the
`ScannerConfig` defined.
4. Use the `AWSScanner` to call the `Scan` method for scanning all the existing
data repositories for the configuration provided.

Here's a code example of how to do that:
```Go
func main() {
ctx := context.Background()
// Define the AWS regions to be scanned.
regions := []string{
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
}
// Define the scanner configuration.
scannerConfig := aws.ScannerConfig{
Regions: regions,
// Optionally define an AssumeRoleConfig if you want to use an IAM Role.
// Otherwise, the AWS default external configurations will be used instead.
// AssumeRole: &aws.AssumeRoleConfig{
// IAMRoleARN: "",
// ExternalID: "",
// },
}
// Create the AWS scanner.
scanner, err := aws.NewAWSScanner(ctx, scannerConfig)
if err != nil {
fmt.Printf("Error creating AWS scanner: %v\n", err)
}
// Run data repositories scan.
results, err := scanner.Scan(ctx)
if err != nil {
fmt.Printf("Scan errors: %v\n", err)
}
// Print number of repositories scanned.
fmt.Printf(
"Scanned %d repositories:\n",
len(results.Repositories),
)
// Print each repository found.
for repoId, repo := range results.Repositories {
fmt.Printf(
"Id: %s | Repo: %v\n\n",
repoId,
repo,
)
}
}
```

## Resources

Learn more about Cyral by visiting [Cyral.com](https://cyral.com/) and also the
links below:

- [Cyral Dmap](https://dmap.cyral.io/)
- [Cyral Public Docs](https://cyral.com/docs/)

## Contribution guidelines

We use [GitHub issues](https://github.com/cyralinc/dmap/issues) for tracking
requests and bugs, please feel free to use that for reporting any requests or
issues.

0 comments on commit 387b581

Please sign in to comment.