Skip to content

Commit

Permalink
updated license from BSD-2 to Apache 2.0 (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
dmennis authored Dec 18, 2020
1 parent 33a4008 commit 23aa53e
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 43 deletions.
16 changes: 10 additions & 6 deletions COPYING
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Copyright (c) 2014-2020, Yubico AB
Copyright (c) 2014-2020 Yubico AB

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
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

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
http://www.apache.org/licenses/LICENSE-2.0

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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.
1 change: 1 addition & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
GA release

* Added Docker deployment
* Apache License 2.0

== Version 0.0.6 ==

Expand Down
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The solution will be provided as an Amazon SAM template that includes the creati

## Backend Resources ##

These resources will be created, configured, and deployed in your own AWS environment using the provided [SAM template](https://github.com/Yubico/WebAuthnKit/blob/master/backend/template.yaml). These services provide registration, authentication, WebAuthn Relying Party, and OPEN ID Connect provider solutions.
These resources will be created, configured, and deployed in your own AWS environment using the provided [SAM template](https://github.com/YubicoLabs/WebAuthnKit/blob/master/backend/template.yaml). These services provide registration, authentication, WebAuthn Relying Party, and OPEN ID Connect provider solutions.

✅ One Amazon Cognito User Pool.
<details><summary>Cognito User Pools as an Identity Provider</summary><p>
Expand All @@ -32,9 +32,9 @@ The WebAuthn Starter Kit relies on Cognito User Pools to store user information

✅ Four AWS Lambda Functions used as custom triggers with Cognito User Pool.

✅ One AWS Lambda Function (Yubico Java WebAuthn Server Library) as the WebAuthn Relying Party library.
✅ One AWS Lambda Function [(Yubico Java WebAuthn Server Library)](https://github.com/Yubico/java-webauthn-server) as the WebAuthn Relying Party.

✅ One Amazon RDS Database - Aurora Serverless (MySQL compatible database used to store user credential attributes).
✅ One Amazon RDS Database - Aurora Serverless (MySQL-compatible database used to store user credential attributes).

✅ One Amazon API Gateway as our RESTful API endpoint.

Expand All @@ -46,24 +46,18 @@ Deploy the backend as outlined in [backend](./backend/README.md).

Once you build and deploy the backend, you can use one of the clients below to connect into the backend.

[Web Client (React)](https://github.com/yubico/WebAuthnKit/tree/master/clients/web/react)
[Web Client (React)](https://github.com/YubicoLabs/WebAuthnKit/tree/master/clients/web/react)

[iOS Client (Swift)](https://github.com/Yubico/WebAuthnKit/tree/master/clients/iOS)
[iOS Client (Swift)](https://github.com/YubicoLabs/WebAuthnKit/tree/master/clients/iOS)

<<<<<<< HEAD
## Cost Considerations ##

We have done our best to reduce the cost of running the Yubico WebAuthn Starter Kit on AWS, however, you are responsible the AWS service fees while running the WebAuthn Starter Kit reference deployment.
=======
### Cost Considerations

We have done our best to reduce the cost of running the Yubico WebAuthn Starter Kit on AWS, however, you are responsible the AWS service fees while running the WebAuthn Starter Kit reference deployment. There is no additional cost for using the WebAuthn Starter Kit reference deployment.
>>>>>>> main

The WebAuthn Starter Kit utilizes an AWS SAM template for quick deployment. This template includes configuration parameters that you can customize to fit your needs and budget. Some of these settings, such as RDS Aurora database, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service used.

Cost Analysis: After you deploy the WebAuthn Starter Kit to your AWS environment, you can create a [AWS Cost and Usage Report](https://docs.aws.amazon.com/cur/latest/userguide/what-is-cur.html) to track costs associated with this deployment. This report will deliver billing metrics (cost estimates based on usage) to an Amazon S3 bucket in your own account.

### License Summary
## License Summary ##

This project is licensed under the [BSD-2-Clause](https://github.com/YubicoLabs/WebAuthnKit/blob/main/COPYING).
This project is licensed under [Apache License 2.0](https://github.com/YubicoLabs/WebAuthnKit/blob/main/COPYING).
14 changes: 7 additions & 7 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is the source code used to build the Yubico WebAuthn Starter Kit solution.

✅ One AWS Lambda Function (Java) as the WebAuthn Relying Party library.

✅ One Amazon RDS Database - Aurora Serverless (MySQL compatible database used to store user credential attributes).
✅ One Amazon RDS Database - Aurora Serverless (MySQL-compatible database used to store user credential attributes).

✅ One Amazon API Gateway as our RESTful API edge endpoint.

Expand All @@ -29,13 +29,13 @@ In this section, we'll clone (or download .zip release) the WebAuthn Starter Kit

### 1. Clone Yubico WebAuthn Starter Kit Repository

$ `git clone https://github.com/Yubico/WebAuthnKit.git`
$ `git clone https://github.com/YubicoLabs/WebAuthnKit.git`

### 2. Choose deployment script

$ `cd WebAuthnKit/scripts`

Choose the platform of your workstation that is deploying the backend. If you are are on a Mac or Linux, choose the [Mac-Linux folder](https://github.com/Yubico/WebAuthnKit/tree/master/scripts/Mac-Linux). If Windows, choose the [PowerShell folder](https://github.com/Yubico/WebAuthnKit/tree/master/scripts/PowerShell).
Choose the platform of your workstation that is deploying the backend. If you are are on a Mac or Linux, choose the [Mac-Linux folder](https://github.com/YubicoLabs/WebAuthnKit/tree/master/scripts/Mac-Linux). If Windows, choose the [PowerShell folder](https://github.com/YubicoLabs/WebAuthnKit/tree/master/scripts/PowerShell).

### 3. Configure Deployment Script (Optional)
Each of the platform-specific scripts read from a configuration file that specifies deployment specific details like AWS region, AWS CLI profile name, and other custom naming options. You don't need to modify the config file if you wish to deploy with all default values.
Expand All @@ -50,10 +50,10 @@ Each of the platform-specific scripts read from a configuration file that specif

- If a parameter is declared in the configuration file, it will be used by the script exactly as declared, without appending any suffix.

### Mac/Linux Script Config
#### Mac/Linux Script Config
`~/WebAuthnKit/scripts/Mac-Linux/deployStarterKit.json`

### Windows PowerShell Script Config
#### Windows PowerShell Script Config
`~\WebAuthnKit\scripts\PowerShell\deployStarterKitPs.json`

## 4. Execute Deployment Script
Expand All @@ -73,11 +73,11 @@ To run the PowerShell script, open a PowerShell prompt and navigate to:

`> .\deployStarterKit.ps1`

The deployment should take about 7-10 minutes.
The deployment should take approx 10-15 minutes.

## Teardown
The deployment scripts are just wrappers of an AWS SAM template which relies on an AWS CloudFormation Stack in the background to deploy ALL the backend services. If you wish to remove all the resources for the WebAuthn Starter Kit, you can delete the CloudFormation Stack used to deploy the resources. Deleting a CloudFormation Stack just reverses the deployment and deletes all the resources it created.

To delete the CloudFormation Stack, launch [CloudFormation Management Console](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks?filteringText=&filteringStatus=active&viewNested=true&hideStacks=false) and delete the stack with the name you provided or the default name webauthn-[suffix].

The teardown should take about 7-10 minutes. Once the stack has been deleted, you should no longer incur any costs for the WebAuthn Starter Kit.
The teardown should take less than 10 minutes. Once the stack has been deleted, you should no longer incur any costs for the WebAuthn Starter Kit.
2 changes: 1 addition & 1 deletion backend/lambda-functions/CreateAuth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause",
"license": "Apache-2.0",
"dependencies": {
"crypto": "^1.0.1",
"data-api-client": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion backend/lambda-functions/CreateDBSchema/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause",
"license": "Apache-2.0",
"dependencies": {
"data-api-client": "^1.1.0"
}
Expand Down
2 changes: 1 addition & 1 deletion backend/lambda-functions/DefineAuth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause"
"license": "Apache-2.0"
}
2 changes: 1 addition & 1 deletion backend/lambda-functions/PreSignUp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause"
"license": "Apache-2.0"
}
2 changes: 1 addition & 1 deletion backend/lambda-functions/VerifyAuth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause",
"license": "Apache-2.0",
"dependencies": {
"base64url": "^3.0.1",
"bcryptjs": "^2.4.3",
Expand Down
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Yubico AB",
"license": "BSD-2-Clause"
"license": "Apache-2.0"
}
13 changes: 2 additions & 11 deletions backend/template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,11 @@ Metadata:
Name: yubico-webauthn-starter-kit
Description:
Custom authentication using Amazon Cognito, AWS Lambda, API Gateway, Aurora Serverless (DB), and a YubiKey
<<<<<<< HEAD
Author: 'Yubico AB'
SpdxLicenseId: 'BSD-2-Clause'
LicenseUrl: ../COPYING
SpdxLicenseId: 'Apache-2.0'
LicenseUrl: 'https://github.com/YubicoLabs/WebAuthnKit/blob/main/COPYING'
ReadmeUrl: README.md
Labels: ['passwordless', 'YubiKey', 'WebAuthn', 'serverless', 'FIDO2', 'Yubico']
=======
Author: Yubico AB
SpdxLicenseId: BSD-2-Clause
LicenseUrl: LICENSE
ReadmeUrl: README.md
Labels: ['passwordless', 'YubiKey', 'WebAuthn', 'serverless', 'FIDO2',
'Yubico']
>>>>>>> main
HomepageUrl: https://github.com/YubicoLabs/WebAuthnKit
SemanticVersion: 1.0.0
SourceCodeUrl: https://github.com/YubicoLabs/WebAuthnKit
Expand Down

0 comments on commit 23aa53e

Please sign in to comment.