Coalfire-Research · davidmans7 · Nov 16, 2019 · Apr 11, 2021 · Apr 16, 2021 · Apr 16, 2021
diff --git a/.gitignore b/.gitignore
@@ -1,30 +1,29 @@
-*.auto.tfvars
 *.pem
-#!terraform/dictionaries.auto.tfvars
 */.terraform*
 *.tfstate
 *.tfstate*
 plan/
 plan/*
 site-content/angular/npk_config.js
 site-content/assets/js/cognito_config.js
+/site-content/assets/js/dictionary-buckets.js
 **/node_modules
-terraform/quotas.json
-terraform/npk-settings.json
-terraform/generated-settings.jsonnet
-terraform/regions.json
-terraform/*.tf.json
-terraform-selfhost/*.tf.json
-terraform/lambda_functions/zip_files/*
-terraform/lambda_functions/proxy_api_handler/api_handler_variables.js
-terraform/lambda_functions/status_reporter/npk_settings.js
-terraform/lambda_functions/spot_monitor/npk_settings.js
-terraform/lambda_functions/proxy_api_handler/userdata.sh
-terraform/templates/api-handler-variables.tpl
-terraform/templates/npk_settings.tpl
-terraform-selfhost/components/
+npk-settings.json
+render-npk*
+lambda_functions/zip_files/*
+lambda_functions/*/accountDetails.json
+lambda_functions/*/ENVVARS
+lambda_functions/proxy_api_handler/api_handler_variables.js
+lambda_functions/status_reporter/npk_settings.js
+lambda_functions/spot_monitor/npk_settings.js
+lambda_functions/proxy_api_handler/userdata.sh
+lambda_functions/execute_campaign/userdata.sh
+templates/api-handler-variables.tpl
+templates/npk_settings.tpl
+tools/components/*
 tools/rules/*
 tools/wordlists/*
-terraform-selfhost/upload_npkfile.sh
-terraform-selfhost/upload_npkcomponents.sh
-terraform-selfhost/sync_npkcomponents.sh
+tools/upload_npkfile.sh
+tools/upload_npkcomponents.sh
+tools/sync_npkcomponents.sh
+**.bak
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/README.md b/README.md
@@ -2,31 +2,41 @@
 
 NPK is a distributed hash-cracking platform built entirely of serverless components in AWS including Cognito, DynamoDB, and S3. It was designed for easy deployment and the intuitive UI brings high-power hash-cracking to everyone.
 
-![Image](/readme-content/dashboard-active.png)
+![dashboard_progress](https://user-images.githubusercontent.com/143415/162669450-1b6da5bb-9e58-4cc5-941c-82b565f86b1b.png)
 
 'NPK' is an initialism for the three primary atomic elements in fertilizer (Nitrogen, Phosphorus, and Potassium). Add it to your hashes to increase your cred yield!
 
 ## How it works
 
-Lets face it - even the beastliest cracking rig spends a lot of time at idle. You sink a ton of money up front on hardware, then have the electricity bill to deal with. NPK lets you leverage extremely powerful hash cracking with the 'pay-as-you-go' benefits of AWS. For example, you can crank out as much as 1.2TH/s of NTLM for a mere $14.70/hr. NPK was also designed to fit easily within the free tier while you're not using it! Without the free tier, it'll still cost less than 25 CENTS per MONTH to have online!
-
-If you'd like to see it in action, check out the video here: https://www.youtube.com/watch?v=BrBPOhxkgzc
+Let's face it - even the beastliest cracking rig spends a lot of time at idle. You sink a ton of money up front on hardware, then have the electricity bill to deal with. NPK lets you leverage extremely powerful hash cracking with the 'pay-as-you-go' benefits of AWS. For example, you can crank out 336 GH/s of NTLM for a mere $1/hr and scale it however you want. NPK was also designed to fit easily within the free tier while you're not using it! Without the free tier, it'll still cost less than $1 per MONTH to have online!
 
 ## Features
 
 ### 1. Super easy install
 
-One config file, one command to run. That's about it.
+Paste a one-liner into AWS CloudShell. Pretty easy.
+
+```source <(curl https://npkproject.io/cloudshell_install.sh)```
+
+If you'd like to use the `dev` branch to use beta features, use this one-liner instead:
+
+```source <(curl https://npkproject.io/cloudshell_install_dev.sh)```
+
+![cloudshell_oneliner](https://user-images.githubusercontent.com/143415/160295789-7b4f21fa-4ac3-4900-b78a-7a974b9f48ac.png)
+
+There are also [Step-by-step instructions](https://github.com/c6fc/npk/wiki/Step-by-step-Installation) if you want them.
 
 ### 2. Intuitive campaign builder
 
 Take the trial-and-error out of complex attack types with the intuitive campaign builder. With a couple clicks you can create advanced campaigns that even advanced Hashcat users would struggle to emulate.
 
+![gpu_families](https://user-images.githubusercontent.com/143415/156901010-a6ae07e8-273b-496c-8916-b0d8955d840f.png)
+
 ### 3. Campaign price and coverage estimates
 
 Take the guess-work out of your campaigns. See how far you'll get and how much it will cost *before* starting the campaign.
 
-![Image](/readme-content/coverage.png)
+![coverage](https://user-images.githubusercontent.com/143415/156901016-a63b2ea1-fcf0-4a48-99c5-a1c6ab2e3221.png)
 
 ### 4. Max price enforcement and runaway instance protection
 
@@ -36,106 +46,75 @@ GPU instances are expensive. Runaway GPU instances are EXTREMELY expensive. NPK
 
 NPK supports multiple users, with strict separation of data, campaigns, and results between each user. It can optionally integrate with SAML-based federated identity providers to enable large teams to use NPK with minimal effort.
 
-![Image](/readme-content/userManagement.png)
+![user_administration](https://user-images.githubusercontent.com/143415/156901873-6c89bb50-5268-4382-aebd-e45ee5ff2f9f.png)
 
 ### 6. Data lifecycle management
 
 Configure how long data will stay in NPK with configurable lifecycle durations during installation. Hashfiles and results are automatically removed after this much time to keep things nicely cleaned up.
 
-## Install
-
-NPK requires that you have the following installed: 
-* **awscli** (v2)
-* **terraform** (v0.11)
-* **jq**
-* **jsonnet**
-* **npm**
+## Easy Install
 
 **ProTip:** To keep things clean and distinct from other things you may have in AWS, it's STRONGLY recommended that you deploy NPK in a fresh account. You can create a new account easily from the 'Organizations' console in AWS. **By 'STRONGLY recommended', I mean 'seriously don't install this next to other stuff'.**
 
-```sh
-$ git clone npk .
-$ cd npk/terraform/
-npk/terraform$ cp npk-settings.json.sample npk-settings.json
-```
+**Note: If you have an older version of NPK that you deployed without the one-liner, you'll need to destroy it before installing the new version**
 
-Edit `npk-settings.json` to taste:
-
-* `backend_bucket`: Is the bucket to store the terraform state in. If it doesn't exist, NPK will create it for you. Replace '<somerandomcharacters>' with random characters to make it unique, or specify another bucket you own.
-* `campaign_data_ttl`: This is the number of seconds that uploaded files and cracked hashes will last before they are automatically deleted. Default is 7 days.
-* `campaign_max_price`: The maximum number of dollars allowed to be spent on a single campaign.
-* `georestrictions`: An array of https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 country codes that access should be WHITELISTED for. Traffic originating from other countries will not be permitted.
-* `useCustomDNS`: A boolean value for whether to use custom domain names for your NPK installation. if set to `true`, you must configure `route53Zone` and `dnsNames` below.
-* `route53Zone`: The Route53 Zone ID for the domain or subdomain you're going to host NPK with. You must configure this zone yourself in the same account before installing NPK.
-* `dnsNames`: This is where you configure the DNS names for the console and api endpoints for your NPK installation. Both domains must be at the same depth as one another; e.g. {www,api}.npk.yourdomain.com
-* `awsProfile`: The profile name in `~/.aws/credentials` that you want to piggyback on for the installation.
-* `criticalEventsSMS`: The cellphone number of a destination to receive critical events to. Only catastrophic errors are reported here, so use a real one.
-* `adminEmail`: The email address of the administrator and first user of NPK. Once the installation is complete, this is where you'll receive your credentials.
-* `useSAML`: Set to `true` if you want to enable SAML-based federated authentication.
-* `sAMLMetadataFile` or `sAMLMetadataUrl`: Only one can be configured, and it's required if `useSAML` is `true`.
-
-Here's an example of a completed config file with custom DNS and no SAML:
-
-```json
-{
-  "backend_bucket": "backend-terraform-npkdev",
-  "campaign_data_ttl": 604800,
-  "campaign_max_price": 50,
-  "georestrictions": [],
-  "useCustomDNS": true,
-  "route53Zone": "Z05471496OWNC3E2EHCI",
-  "dnsNames": {
-    "www": [
-      "www.npk.yourdomain.com"
-    ],
-    "api": [
-      "api.npk.yourdomain.com"
-    ]
-  },
-  "awsProfile": "npkdev",
-  "criticalEventsSMS": "+12085551234",
-  "adminEmail": "[email protected]",
-  "debug_lambda": true,
-
-  "useSAML": false,
-  "sAMLMetadataFile": ""
-}
-```
-After that, run the deploy!
+1. Log into the AWS Console for the account you want to deploy to.
+2. Click the AWS CloudShell button in the top right corner.
+![cloudshell_icon](https://user-images.githubusercontent.com/143415/156901055-5107d4b2-c5b4-4ca5-8454-57e7504e2316.png)
 
-```sh
-npk/terraform$ ./deploy.sh
-```
+3. Paste in the one-liner: `source <(curl https://npkproject.io/cloudshell_install.sh)`
+4. Use the wizard to complete the configuration
+
+When the deploy finishes, you'll be dropped to a custom prompt, which indicates that NPK is deployed and CloudShell is connected to it.
+
+![deployed_prompt](https://user-images.githubusercontent.com/143415/160296855-d2b5a383-445f-44a7-8a06-0051ad215536.png)
+
+If you said 'no' at the end of the wizard, you can run `npm run deploy` from this prompt to finish the deployment.
+
+See https://github.com/c6fc/npk/wiki/Detailed-NPK-Settings for more details about advanced configurations, or https://github.com/c6fc/npk/wiki/Configuring-SAML-SSO for help configuring SAML SSO.
 
-For more details about each setting, their effects, and allowed values, check out [the wiki](https://github.com/Coalfire-Research/npk/wiki/Detailed-NPK-Settings). For more details around custom installations, see [Detailed Instructions](https://github.com/Coalfire-Research/npk/wiki/Detailed-Usage-Instructions).
+## Connect to an existing installation
 
-NPK will use the specified AWS cli profile to fully deploy NPK and provision the first user. If you'd like to change the configuration, simply run `./deploy.sh` again afterward. While it's deploying, pay a visit to https://aws.amazon.com/marketplace/pp/B07S5G9S1Z to subscribe and accept the terms of NVidia's AMIs. NPK uses these to ensure compatability with the GPUs. There is no cost associated with this step, but allows NPK to use these AMIs on your behalf.
+**Note: If you have an older version of NPK that you deployed without the one-liner, you'll need to destroy it before installing the new version**
 
-Once it's done, you'll receive an email with the URL and credentials to your deployment:
+To connect to an existing NPK installation (which is needed to modify or uninstall NPK), log into the AWS account where NPK resides, click the CloudShell icon, and paste in the one-liner:
 
-![Image](/readme-content/npk-invite.png)
+```source <(curl https://npkproject.io/cloudshell_install.sh)```
 
-**NOTE: CloudFront may take several minutes to come up after the deployment is done. This is normal. Grab yourself a cup of coffee after the deploy and give the cloud a few minutes to do its magic.**
+CloudShell will now connect to NPK (which may take a minute or two), after which you'll drop to a new prompt that looks like this:
+
+![deployed_prompt](https://user-images.githubusercontent.com/143415/160296855-d2b5a383-445f-44a7-8a06-0051ad215536.png)
+
+You're now connected to your NPK installation. This can be performed by any user in the AWS account with admin rights, and can be performed in any region.
 
 ## Modify Install
 
-You can change the settings of an install without losing your existing campaigns. Edit `npk-settings.json` as necessary, then rerun `deploy.sh`. That easy!
+You can change the settings of an install without losing your existing campaigns. Use the instructions above to connect to your NPK installation, then edit `npk-settings.json` as necessary and run `npm run update`. It's that easy!
 
 ```sh
-npk/terraform$ vim npk-settings.json
-npk/terraform$ ./deploy.sh
+cloudshell-user$ source <(curl https://npkproject.io/cloudshell_install.sh)
+@c6fc/npk> vim npk-settings.json
+< ... change your settings however you need >
+@c6fc/npk> npm run update
 ```
 
+## Uploading your own dictionaries and rule files
+
+Once NPK has been deployed, administrative users can use the NPK console to upload wordlists and rule files using the 'Dictionary Management' link in the sidebar. NPK supports plain-text and gzipped dictionaries.
+
+![upload_dictionaries](https://user-images.githubusercontent.com/143415/156901465-6e906177-e9fa-4189-8cda-0735813d02c0.png)
+
 ## Uninstall
 
-You can completely turn down NPK and delete all of its data from AWS with a single command:
+You can completely turn down NPK and delete all of its data from AWS very easily. Just attach your CloudShell to NPK, then run `npm run destroy`:
 
 ```sh
-npk/terraform$ terraform destroy
+cloudshell-user$ source <(curl https://npkproject.io/cloudshell_install.sh)
+@c6fc/npk> npm run destroy
 ```
 
 # Official Discord Channel
 
-Come hang out on Discord!
+Have questions, need help, want to contribute or brag about a win? Come hang out on Discord!
 
-[![Porchetta Industries](https://discordapp.com/api/guilds/736724457258745996/widget.png?style=banner3)](https://discord.gg/k5PQnqSNDF)
+[![Official c6fc Discord](https://discordapp.com/api/guilds/825770240309985310/widget.png?style=banner3)](https://discord.gg/w4G5k92czX)