Skip to content

Commit

Permalink
LICENSE, README, remove peer dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
odedniv committed Jul 4, 2017
1 parent d5d9641 commit 7e42811
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 15 deletions.
31 changes: 31 additions & 0 deletions LICENSE
@@ -0,0 +1,31 @@
The MIT License (MIT)

Copyright (c) 2017 Puresec Ltd. https://www.puresec.io

The following license applies to all parts of this software except as
documented below:

----

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

----

All external and 3rd party directories are externally maintained libraries used by this software which have their
own licenses; we recommend you read them, as their terms may differ from the terms above.
50 changes: 39 additions & 11 deletions README.md
Expand Up @@ -2,40 +2,68 @@

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![npm version](https://badge.fury.io/js/serverless-puresec-cli.svg)](https://badge.fury.io/js/serverless-puresec-cli)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contributing)

[Website](https://www.puresec.io/)[Newsletter](http://eepurl.com/cPu0_b)[Slack](http://slack-signup.puresec.io)[Twitter](https://twitter.com/PureSecTeam/)

Serverless plugin for [PureSec CLI](https://github.com/puresec/puresec-cli).

## Installation
## Features

* Saves you time - automatically creates IAM roles for you
* Reduces the attack surface of your AWS Lambda based application
* Helps creating least privileged roles with the minimum required permissions
* Currently supported runtimes: Node.js (more runtimes coming soon...)
* Currently supported services: DynamoDB, Kinesis, KMS, S3, SES, SNS & Step Functions
* Works with the [Serverless Framework](https://github.com/serverless/serverless)

First, add serverless-puresec-cli to your project:
## Quick Start

**1. Install via npm:**

```bash
npm install --save-dev serverless-puresec-cli
```

Then inside your project's `serverless.yml` file add following entry to the plugins section: `serverless-puresec-cli`. If there is no plugin section you will need to add it to the file.
**2. Add serverless-puresec-cli to your serverless.yml:**

In your project's `serverless.yml` file add the following entry to the plugins section: `serverless-puresec-cli`.
If there is no plugin section you will need to add it to the file.

It should look something like this:
It should look similar to this:
```yaml
plugins:
- serverless-puresec-cli
```

You can check wether you have successfully installed the plugin by running the serverless command line:
**3. Validate:**

You can check wether you have successfully installed the plugin by running the serverless command line.

```bash
serverless
```

the console should display *puresec* as one of the plugins now available in your Serverless project.

the console should display **puresec** as one of the plugins now available in your Serverless project.

## Usage
**4. Start using serverless-puresec-cli:**

In your project root run:
Generate roles for your entire project.

```bash
serverless puresec
serverless puresec gen-roles
```

The tool will ask you a few questions and then do its best to generate least privileged IAM roles.

**5. You can try the tool by executing it on a single function**:

```bash
serverless puresec gen-roles --function myFunction
```

## Links

* [Website](https://www.puresec.io/) (Our main product is still in closed beta)
* [Newsletter](http://eepurl.com/cPu0_b)
* [Slack](http://slack-signup.puresec.io)
* [Twitter](https://twitter.com/PureSecTeam/)
3 changes: 0 additions & 3 deletions package.json
Expand Up @@ -32,8 +32,5 @@
"dependencies": {
"git+ssh://git@github.com/puresec/puresec-cli.git": ""
}
},
"peerDependencies": {
"serverless": "1.x"
}
}
2 changes: 1 addition & 1 deletion src/index.js
Expand Up @@ -11,7 +11,7 @@ class PureSecCLI {

this.commands = {
puresec: {
usage: 'Run PureSec CLI commands',
usage: "PureSec CLI tools for improving the security of your serverless applications",
lifecycleEvents: [
'puresec',
],
Expand Down

0 comments on commit 7e42811

Please sign in to comment.