loopback-ssl - npm Package Compare versions

Comparing version 0.0.8 to 0.0.9

package.json

 {
   "name": "loopback-ssl",
-  "version": "0.0.8",
-  "description": "Node module to enable SSL or Mutual SSL in any loopback application",
+  "version": "0.0.9",
+  "description": "Node module to enable HTTPS/SSL in a loopback application with simple configurations. The module in addition enables trusted peer authentication.",
   "main": "index.js",
@@ -17,3 +17,6 @@ "scripts": {
     "mutual authentication",
-    "two way ssl"
+    "two way ssl",
+    "trusted peer",
+    "certificate",
+    "https"
   ],
@@ -33,3 +36,3 @@ "author": "Siddhartha Lahiri",
     "gulp": "3.9.1",
-    "gulp-codacy": "^1.0.0",
+    "gulp-codacy": "1.0.0",
     "gulp-eslint": "3.0.1",
@@ -36,0 +39,0 @@ "gulp-exit": "0.0.2",

README.md

 # loopback-ssl
 
-Component for [loopback] to enable SSL or Mutual SSL Authentication
+Node module to enable HTTPS/SSL in a [loopback] application with simple configurations. The module also enables trusted peer authentication.
 
-[![Travis](https://img.shields.io/travis/yantrashala/loopback-ssl.svg?style=plastic)](https://img.shields.io/travis/yantrashala/loopback-ssl/master.svg) [![npm](https://img.shields.io/npm/dm/loopback-ssl.svg?style=plastic)](https://nodei.co/npm/loopback-ssl/) [![npm](https://img.shields.io/npm/dt/loopback-ssl.svg?style=plastic)](https://nodei.co/npm/loopback-ssl/) [![npm](https://img.shields.io/npm/l/loopback-ssl.svg?style=plastic)](https://github.com/yantrashala/loopback-ssl) [![David](https://img.shields.io/david/dev/yantrashala/loopback-ssl.svg?style=plastic)](https://www.npmjs.com/package/loopback-ssl) [![David](https://img.shields.io/david/yantrashala/loopback-ssl.svg?style=plastic)](https://www.npmjs.com/package/loopback-ssl) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/74ddc643152f4f439d6ef7d99ed9d5f6)](https://www.codacy.com/app/siddhartha-lahiri/loopback-ssl?utm_source=github.com&utm_medium=referral&utm_content=yantrashala/loopback-ssl&utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/74ddc643152f4f439d6ef7d99ed9d5f6)](https://www.codacy.com/app/siddhartha-lahiri/loopback-ssl?utm_source=github.com&utm_medium=referral&utm_content=yantrashala/loopback-ssl&utm_campaign=Badge_Coverage)
+[![Travis](https://img.shields.io/travis/yantrashala/loopback-ssl.svg?style=plastic)](https://img.shields.io/travis/yantrashala/loopback-ssl/master.svg) [![npm](https://img.shields.io/npm/dm/loopback-ssl.svg?style=plastic)](https://nodei.co/npm/loopback-ssl/) [![npm](https://img.shields.io/npm/dt/loopback-ssl.svg?style=plastic)](https://nodei.co/npm/loopback-ssl/) [![npm](https://img.shields.io/npm/l/loopback-ssl.svg?style=plastic)](https://github.com/yantrashala/loopback-ssl) [![David](https://img.shields.io/david/dev/yantrashala/loopback-ssl.svg?style=plastic)](https://www.npmjs.com/package/loopback-ssl) [![David](https://img.shields.io/david/yantrashala/loopback-ssl.svg?style=plastic)](https://www.npmjs.com/package/loopback-ssl) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/74ddc643152f4f439d6ef7d99ed9d5f6)](https://www.codacy.com/app/siddhartha-lahiri/loopback-ssl?utm_source=github.com&utm_medium=referral&utm_content=yantrashala/loopback-ssl&utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/74ddc643152f4f439d6ef7d99ed9d5f6)](https://www.codacy.com/app/siddhartha-lahiri/loopback-ssl?utm_source=github.com&utm_medium=referral&utm_content=yantrashala/loopback-ssl&utm_campaign=Badge_Coverage) [![Join the chat at https://gitter.im/yantrashala/loopback-ssl](https://badges.gitter.im/yantrashala/loopback-ssl.svg)](https://gitter.im/yantrashala/loopback-ssl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -81,9 +81,12 @@
 
-## Disable HTTPS
-The configuration entry `"httpMode": false` will disable https. In this mode the `"certConfig": {..}` configuration is not used and can be omitted.
+## Option 1: Enable HTTP (default loopback configuration)
+The configuration entry `"httpMode": true` will enable http (disable https). In this mode the `"certConfig": {..}` configuration is not required and can be omitted.
+```js
+  "httpMode": true
+```
 
-## Enable SSL
-Configuration sample to enable SSL
+## Option 2: Enable HTTPS
+The configuration entry `"httpMode": false` will enable https. 
 ```js
-  "httpMode": true,
+  "httpMode": false,
   "certConfig": {
@@ -102,5 +105,5 @@ "path": "/certificate/path/",
 
-## Enable Mutual SSL
+## Option 3: Enable Mutual SSL authentication
 ```js
-  "httpMode": true,
+  "httpMode": flase,
   "certConfig": {
@@ -122,2 +125,10 @@ "path": "/certificate/path/",
 
+# Contributing
+
+- Fork it ( https://github.com/yantrashala/loopback-ssl/fork )
+- Create your feature branch (git checkout -b new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin new-feature)
+- Create new Pull Request
+
 # License
@@ -129,4 +140,2 @@
 
-- [Loopback][loopback]
-- [Trusted Peer - Example][trusted_peer]
 - [Self Signed Certificates - Example][self_signed]
@@ -133,0 +142,0 @@

test/fixtures/configs/config-5.json

@@ -7,3 +7,5 @@ {
     "cert": "local.crt.pem",
-    "ca": [],
+    "ca": [
+      "local.crt.pem"
+    ],
     "requestCert": true,
@@ -10,0 +12,0 @@ "rejectUnauthorized": false

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26892

increased by3.19%

Lines of code

585

increased by0.34%

Number of lines in readme file

143

increased by6.72%

Number of medium supply chain risk alerts

1

decreased by-50%

No dependency changes