@adobe/aio-cli-plugin-certificate 0.4.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -32,14 +32,17 @@ $ aio certificate --help
32
32
 
33
33
  ## `aio certificate`
34
34
 
35
- Generate or verify a certificate for use with Adobe I/O
35
+ Generate, fingerprint, or verify a certificate for use with Adobe I/O
36
36
 
37
37
  ```
38
38
  USAGE
39
39
  $ aio certificate
40
+
41
+ DESCRIPTION
42
+ Generate, fingerprint, or verify a certificate for use with Adobe I/O
40
43
  ```
41
44
 
42
- _See code: [src/commands/certificate/index.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/0.4.0/src/commands/certificate/index.js)_
45
+ _See code: [src/commands/certificate/index.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/1.0.0/src/commands/certificate/index.js)_
43
46
 
44
47
  ## `aio certificate:fingerprint FILE`
45
48
 
@@ -47,13 +50,16 @@ Compute the fingerprint of a public key certificate for use with Adobe I/O
47
50
 
48
51
  ```
49
52
  USAGE
50
- $ aio certificate:fingerprint FILE
53
+ $ aio certificate:fingerprint [FILE]
51
54
 
52
55
  ARGUMENTS
53
56
  FILE file path to certificate to fingerprint
57
+
58
+ DESCRIPTION
59
+ Compute the fingerprint of a public key certificate for use with Adobe I/O
54
60
  ```
55
61
 
56
- _See code: [src/commands/certificate/fingerprint.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/0.4.0/src/commands/certificate/fingerprint.js)_
62
+ _See code: [src/commands/certificate/fingerprint.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/1.0.0/src/commands/certificate/fingerprint.js)_
57
63
 
58
64
  ## `aio certificate:generate`
59
65
 
@@ -61,33 +67,29 @@ Generate a new private/public key pair
61
67
 
62
68
  ```
63
69
  USAGE
64
- $ aio certificate:generate
65
-
66
- OPTIONS
67
- -c, --country=country Country Name
68
- -l, --locality=locality Locality, or city name
69
-
70
- -n, --name=name [default: selfsign.localhost] Common Name: typically a host domain name, like
71
- www.mysite.com
72
-
73
- -o, --organization=organization Organization name
74
-
75
- -s, --state=state State or Province
76
-
77
- -u, --unit=unit Organizational unit or department
78
-
79
- --days=days [default: 365] Number of days the certificate should be valid for. (Max 365)
80
-
81
- --keyout=keyout [default: private.key] file to send the key to
82
-
83
- --out=out [default: certificate_pub.crt] output file
70
+ $ aio certificate:generate [--keyout <value>] [--out <value>] [-n <value>] [-c <value>] [-s <value>] [-l <value>] [-o
71
+ <value>] [-u <value>] [--days <value>]
72
+
73
+ FLAGS
74
+ -c, --country=<value> Country Name
75
+ -l, --locality=<value> Locality, or city name
76
+ -n, --name=<value> [default: selfsign.localhost] Common Name: typically a host domain name, like
77
+ www.mysite.com
78
+ -o, --organization=<value> Organization name
79
+ -s, --state=<value> State or Province
80
+ -u, --unit=<value> Organizational unit or department
81
+ --days=<value> [default: 365] Number of days the certificate should be valid for. (Max 365)
82
+ --keyout=<value> [default: private.key] file to send the key to
83
+ --out=<value> [default: certificate_pub.crt] output file
84
84
 
85
85
  DESCRIPTION
86
- Generate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe
86
+ Generate a new private/public key pair
87
+
88
+ Generate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe
87
89
  services.
88
90
  ```
89
91
 
90
- _See code: [src/commands/certificate/generate.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/0.4.0/src/commands/certificate/generate.js)_
92
+ _See code: [src/commands/certificate/generate.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/1.0.0/src/commands/certificate/generate.js)_
91
93
 
92
94
  ## `aio certificate:verify FILE`
93
95
 
@@ -95,19 +97,21 @@ Verify a certificate for use with Adobe I/O
95
97
 
96
98
  ```
97
99
  USAGE
98
- $ aio certificate:verify FILE
100
+ $ aio certificate:verify [FILE] [--days <value>]
99
101
 
100
102
  ARGUMENTS
101
103
  FILE file path to certificate to verify
102
104
 
103
- OPTIONS
104
- --days=days +- is certificate valid in --days
105
+ FLAGS
106
+ --days=<value> +- is certificate valid in --days
105
107
 
106
108
  DESCRIPTION
109
+ Verify a certificate for use with Adobe I/O
110
+
107
111
  Verifies that the certificate is valid, and/or will not expire in [--days] days from now.
108
112
  ```
109
113
 
110
- _See code: [src/commands/certificate/verify.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/0.4.0/src/commands/certificate/verify.js)_
114
+ _See code: [src/commands/certificate/verify.js](https://github.com/adobe/aio-cli-plugin-certificate/blob/1.0.0/src/commands/certificate/verify.js)_
111
115
  <!-- commandsstop -->
112
116
 
113
117
  ## Contributing
@@ -1 +1 @@
1
- {"version":"0.4.0","commands":{"certificate:fingerprint":{"id":"certificate:fingerprint","description":"Compute the fingerprint of a public key certificate for use with Adobe I/O","pluginName":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"file","description":"file path to certificate to fingerprint","required":true}]},"certificate:generate":{"id":"certificate:generate","description":"Generate a new private/public key pair\nGenerate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe services.\n","pluginName":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{"keyout":{"name":"keyout","type":"option","description":"file to send the key to","default":"private.key"},"out":{"name":"out","type":"option","description":"output file","default":"certificate_pub.crt"},"name":{"name":"name","type":"option","char":"n","description":"Common Name: typically a host domain name, like www.mysite.com","default":"selfsign.localhost"},"country":{"name":"country","type":"option","char":"c","description":"Country Name"},"state":{"name":"state","type":"option","char":"s","description":"State or Province"},"locality":{"name":"locality","type":"option","char":"l","description":"Locality, or city name"},"organization":{"name":"organization","type":"option","char":"o","description":"Organization name"},"unit":{"name":"unit","type":"option","char":"u","description":"Organizational unit or department"},"days":{"name":"days","type":"option","description":"Number of days the certificate should be valid for. (Max 365)","default":365}},"args":[]},"certificate":{"id":"certificate","description":"Generate or verify a certificate for use with Adobe I/O","pluginName":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{},"args":[]},"certificate:verify":{"id":"certificate:verify","description":"Verify a certificate for use with Adobe I/O\nVerifies that the certificate is valid, and/or will not expire in [--days] days from now.\n","pluginName":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{"days":{"name":"days","type":"option","description":"+- is certificate valid in --days"}},"args":[{"name":"file","description":"file path to certificate to verify","required":true}]}}}
1
+ {"version":"1.0.0","commands":{"certificate:fingerprint":{"id":"certificate:fingerprint","description":"Compute the fingerprint of a public key certificate for use with Adobe I/O","strict":true,"pluginName":"@adobe/aio-cli-plugin-certificate","pluginAlias":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"file","description":"file path to certificate to fingerprint","required":true}]},"certificate:generate":{"id":"certificate:generate","description":"Generate a new private/public key pair\nGenerate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe services.\n","strict":true,"pluginName":"@adobe/aio-cli-plugin-certificate","pluginAlias":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{"keyout":{"name":"keyout","type":"option","description":"file to send the key to","multiple":false,"default":"private.key"},"out":{"name":"out","type":"option","description":"output file","multiple":false,"default":"certificate_pub.crt"},"name":{"name":"name","type":"option","char":"n","description":"Common Name: typically a host domain name, like www.mysite.com","multiple":false,"default":"selfsign.localhost"},"country":{"name":"country","type":"option","char":"c","description":"Country Name","multiple":false},"state":{"name":"state","type":"option","char":"s","description":"State or Province","multiple":false},"locality":{"name":"locality","type":"option","char":"l","description":"Locality, or city name","multiple":false},"organization":{"name":"organization","type":"option","char":"o","description":"Organization name","multiple":false},"unit":{"name":"unit","type":"option","char":"u","description":"Organizational unit or department","multiple":false},"days":{"name":"days","type":"option","description":"Number of days the certificate should be valid for. (Max 365)","multiple":false,"default":365}},"args":[]},"certificate":{"id":"certificate","description":"Generate, fingerprint, or verify a certificate for use with Adobe I/O","strict":true,"pluginName":"@adobe/aio-cli-plugin-certificate","pluginAlias":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{},"args":[]},"certificate:verify":{"id":"certificate:verify","description":"Verify a certificate for use with Adobe I/O\nVerifies that the certificate is valid, and/or will not expire in [--days] days from now.\n","strict":true,"pluginName":"@adobe/aio-cli-plugin-certificate","pluginAlias":"@adobe/aio-cli-plugin-certificate","pluginType":"core","aliases":[],"flags":{"days":{"name":"days","type":"option","description":"+- is certificate valid in --days","multiple":false}},"args":[{"name":"file","description":"file path to certificate to verify","required":true}]}}}
package/package.json CHANGED
@@ -1,24 +1,19 @@
1
1
  {
2
2
  "name": "@adobe/aio-cli-plugin-certificate",
3
- "version": "0.4.0",
4
- "description": "Generate and validate private certs, and public key pairs for use with Adobe IO Console",
3
+ "version": "1.0.0",
4
+ "description": "Generate and validate private certificates, and public key pairs for use with Adobe IO Console",
5
5
  "repository": "adobe/aio-cli-plugin-certificate",
6
6
  "homepage": "https://github.com/adobe/aio-cli-plugin-certificate",
7
7
  "dependencies": {
8
- "@oclif/command": "^1",
9
- "@oclif/config": "^1",
10
- "@oclif/errors": "^1.1.2",
11
- "debug": "^4.1.0",
8
+ "@oclif/core": "^1.9.0",
9
+ "debug": "^4.3.3",
12
10
  "fs-extra": "^9.0.0",
13
11
  "node-forge": "^1.3.0"
14
12
  },
15
13
  "devDependencies": {
16
- "@oclif/dev-cli": "^1.21.3",
17
- "@oclif/plugin-help": "^2.1.4",
18
- "@oclif/test": "^1",
19
14
  "codecov": "^3.2.0",
20
15
  "eslint": "^6.8.0",
21
- "eslint-config-oclif": "^3.1.0",
16
+ "eslint-config-oclif": "^4.0.0",
22
17
  "eslint-config-standard": "^14.1.0",
23
18
  "eslint-plugin-import": "^2.13.10",
24
19
  "eslint-plugin-jest": "^23.6.0",
@@ -28,10 +23,11 @@
28
23
  "jest": "^24.1.0",
29
24
  "jest-junit": "^10.0.0",
30
25
  "jest-resolve": "^26.0.0",
26
+ "oclif": "^3.0.1",
31
27
  "stdout-stderr": "^0.1.9"
32
28
  },
33
29
  "engines": {
34
- "node": ">=10.0.0"
30
+ "node": "^14.18 || ^16.13 || >=18"
35
31
  },
36
32
  "files": [
37
33
  "/oclif.manifest.json",
@@ -46,9 +42,6 @@
46
42
  "oclif": {
47
43
  "commands": "./src/commands",
48
44
  "bin": "aio",
49
- "devPlugins": [
50
- "@oclif/plugin-help"
51
- ],
52
45
  "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>"
53
46
  },
54
47
  "main": "src/certificate.js",
@@ -56,9 +49,9 @@
56
49
  "posttest": "eslint src test",
57
50
  "test": "npm run unit-tests",
58
51
  "unit-tests": "jest --ci",
59
- "prepack": "oclif-dev manifest && oclif-dev readme",
52
+ "prepack": "oclif manifest && oclif readme",
60
53
  "postpack": "rm -f oclif.manifest.json",
61
- "version": "oclif-dev readme && git add README.md"
54
+ "version": "oclif readme && git add README.md"
62
55
  },
63
56
  "jest": {
64
57
  "collectCoverage": true,
@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
10
10
  governing permissions and limitations under the License.
11
11
  */
12
12
 
13
- const { Command } = require('@oclif/command')
13
+ const { Command } = require('@oclif/core')
14
14
  const fs = require('fs-extra')
15
15
  const debug = require('debug')('aio-cli-plugin-certificate:fingerprint')
16
16
 
@@ -18,7 +18,7 @@ const cert = require('../../certificate')
18
18
 
19
19
  class FingerprintCommand extends Command {
20
20
  async run () {
21
- const { args } = this.parse(FingerprintCommand)
21
+ const { args } = await this.parse(FingerprintCommand)
22
22
 
23
23
  if (!fs.existsSync(args.file)) {
24
24
  this.error('input file does not exist: ' + args.file)
@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
10
10
  governing permissions and limitations under the License.
11
11
  */
12
12
 
13
- const { Command, flags } = require('@oclif/command')
13
+ const { Command, Flags } = require('@oclif/core')
14
14
  const fs = require('fs-extra')
15
15
  const debug = require('debug')('aio-cli-plugin-certificate:generate')
16
16
 
@@ -18,7 +18,7 @@ const cert = require('../../certificate')
18
18
 
19
19
  class GenerateCommand extends Command {
20
20
  async run () {
21
- const { flags } = this.parse(GenerateCommand)
21
+ const { flags } = await this.parse(GenerateCommand)
22
22
  if (fs.existsSync(flags.keyout)) {
23
23
  this.error('--keyout file exists: ' + flags.keyout)
24
24
  }
@@ -40,40 +40,40 @@ Generate a self-signed certificate to enable https:// on localhost or signing jw
40
40
  `
41
41
 
42
42
  GenerateCommand.flags = {
43
- keyout: flags.string({
43
+ keyout: Flags.string({
44
44
  description: 'file to send the key to',
45
45
  default: 'private.key'
46
46
  }),
47
- out: flags.string({
47
+ out: Flags.string({
48
48
  description: 'output file',
49
49
  default: 'certificate_pub.crt'
50
50
  }),
51
- name: flags.string({
51
+ name: Flags.string({
52
52
  char: 'n',
53
53
  description: 'Common Name: typically a host domain name, like www.mysite.com',
54
54
  default: 'selfsign.localhost'
55
55
  }),
56
- country: flags.string({
56
+ country: Flags.string({
57
57
  char: 'c',
58
58
  description: 'Country Name'
59
59
  }),
60
- state: flags.string({
60
+ state: Flags.string({
61
61
  char: 's',
62
62
  description: 'State or Province'
63
63
  }),
64
- locality: flags.string({
64
+ locality: Flags.string({
65
65
  char: 'l',
66
66
  description: 'Locality, or city name'
67
67
  }),
68
- organization: flags.string({
68
+ organization: Flags.string({
69
69
  char: 'o',
70
70
  description: 'Organization name'
71
71
  }),
72
- unit: flags.string({
72
+ unit: Flags.string({
73
73
  char: 'u',
74
74
  description: 'Organizational unit or department'
75
75
  }),
76
- days: flags.integer({
76
+ days: Flags.integer({
77
77
  description: 'Number of days the certificate should be valid for. (Max 365)',
78
78
  default: 365
79
79
  })
@@ -10,16 +10,15 @@ OF ANY KIND, either express or implied. See the License for the specific languag
10
10
  governing permissions and limitations under the License.
11
11
  */
12
12
 
13
- const HHelp = require('@oclif/plugin-help').default
14
- const { Command } = require('@oclif/command')
13
+ const { Command, Help } = require('@oclif/core')
15
14
 
16
15
  class AIOCommand extends Command {
17
16
  async run () {
18
- const help = new HHelp(this.config)
19
- help.showHelp(['certificate:generate', '--help'])
17
+ const help = new Help(this.config)
18
+ return await help.showHelp(['certificate', '--help'])
20
19
  }
21
20
  }
22
21
 
23
- AIOCommand.description = 'Generate or verify a certificate for use with Adobe I/O'
22
+ AIOCommand.description = 'Generate, fingerprint, or verify a certificate for use with Adobe I/O'
24
23
 
25
24
  module.exports = AIOCommand
@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
10
10
  governing permissions and limitations under the License.
11
11
  */
12
12
 
13
- const { Command, flags } = require('@oclif/command')
13
+ const { Command, Flags } = require('@oclif/core')
14
14
  const fs = require('fs-extra')
15
15
  const debug = require('debug')('aio-cli-plugin-certificate:verify')
16
16
 
@@ -18,7 +18,7 @@ const cert = require('../../certificate')
18
18
 
19
19
  class VerifyCommand extends Command {
20
20
  async run () {
21
- const { flags, args } = this.parse(VerifyCommand)
21
+ const { flags, args } = await this.parse(VerifyCommand)
22
22
 
23
23
  if (!fs.existsSync(args.file)) {
24
24
  this.error('input file does not exist: ' + args.file)
@@ -65,7 +65,7 @@ Verifies that the certificate is valid, and/or will not expire in [--days] days
65
65
  `
66
66
 
67
67
  VerifyCommand.flags = {
68
- days: flags.integer({
68
+ days: Flags.integer({
69
69
  description: '+- is certificate valid in --days'
70
70
  })
71
71
  }