vestauth 0.2.0 → 0.2.3

package/README.md

@@ -1,3 +1,32 @@
-# vestauth
+[![vestauth](https://vestauth.com/banner.png)](https://vestauth.com)
 
-coming soon
+*auth for agents*–from the creator of [`dotenvx`](https://github.com/dotenvx/dotenvx).
+
+* auth
+
+ 
+
+### Quickstart [![npm version](https://img.shields.io/npm/v/vestauth.svg)](https://www.npmjs.com/package/vestauth) [![downloads](https://img.shields.io/npm/dw/vestauth)](https://www.npmjs.com/package/vestauth)
+
+```sh
+npm install vestauth --save
+```
+```js
+// index.js
+// TODO
+```
+
+ 
+
+or install globally - *unlocks vestauth for any language, framework, or platform!*
+
+<details><summary>with curl 🌐 </summary><br>
+
+```sh
+curl -sfS https://vestauth.sh | sh
+vestauth help
+```
+
+&nbsp;
+
+</details>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vestauth",
-  "version": "0.2.0",
-  "description": "auth for agents",
+  "version": "0.2.3",
+  "description": "auth for agents–from the creator of dotenvx",
   "keywords": [
     "vestauth"
   ],
@@ -37,6 +37,7 @@
     "release": "standard-version"
   },
   "dependencies": {
+    "@dotenvx/dotenvx": "^1.52.0",
     "@noble/hashes": "^1.8.0",
     "@noble/secp256k1": "^1.7.2",
     "commander": "^11.1.0",

package/src/cli/actions/agent/hello.js

@@ -0,0 +1,22 @@
+const { logger } = require('./../../../shared/logger')
+
+const agent = require('./../../../lib/agent')
+
+function hello () {
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+
+  const output = {
+    hello: agent.hello()
+  }
+
+  let space = 0
+  if (options.prettyPrint) {
+    space = 2
+  }
+
+  console.log(JSON.stringify(output, null, space))
+}
+
+module.exports = hello

package/src/cli/actions/agent/init.js

@@ -0,0 +1,19 @@
+const { logger } = require('./../../../shared/logger')
+
+const agent = require('./../../../lib/agent')
+
+function init () {
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  const output = agent.init()
+
+  let space = 0
+  if (options.prettyPrint) {
+    space = 2
+  }
+
+  console.log(JSON.stringify(output, null, space))
+}
+
+module.exports = init

package/src/cli/actions/primitives/challenge.js

@@ -1,12 +1,12 @@
 const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const primitives = require('./../../../lib/primitives')
 
 function challenge () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const chal = main.challenge()
+  const chal = primitives.challenge()
 
   const output = {
     challenge: chal

package/src/cli/actions/primitives/hash.js

@@ -1,6 +1,6 @@
 const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const primitives = require('./../../../lib/primitives')
 
 function hash (message) {
   logger.debug(`message: ${message}`)
@@ -8,7 +8,7 @@ function hash (message) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const hashMessage = main.hash(message)
+  const hashMessage = primitives.hash(message)
   const hashBase64Url = Buffer.from(hashMessage).toString('base64url')
 
   const output = {

package/src/cli/actions/primitives/keypair.js

@@ -1,12 +1,12 @@
 const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const primitives = require('./../../../lib/primitives')
 
 function keypair (existingPrivateKey) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const kp = main.keypair(existingPrivateKey, options.prefix)
+  const kp = primitives.keypair(existingPrivateKey, options.prefix)
 
   const output = {
     public_key: kp.publicKey,

package/src/cli/actions/primitives/sign.js

@@ -1,6 +1,6 @@
 const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const primitives = require('./../../../lib/primitives')
 
 async function sign (challenge, privateKeyHex) {
   logger.debug(`challenge: ${challenge}`)
@@ -9,7 +9,7 @@ async function sign (challenge, privateKeyHex) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const signature = await main.sign(challenge, privateKeyHex)
+  const signature = await primitives.sign(challenge, privateKeyHex)
 
   const output = {
     signature

package/src/cli/actions/primitives/verify.js

@@ -1,6 +1,6 @@
 const { logger } = require('./../../../shared/logger')
 
-const main = require('./../../../lib/main')
+const primitives = require('./../../../lib/primitives')
 
 async function verify (challenge, signatureBase64, publicKeyHex) {
   logger.debug(`challenge: ${challenge}`)
@@ -10,7 +10,7 @@ async function verify (challenge, signatureBase64, publicKeyHex) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const success = main.verify(challenge, signatureBase64, publicKeyHex)
+  const success = primitives.verify(challenge, signatureBase64, publicKeyHex)
 
   const output = {
     success,

package/src/cli/commands/agent.js

@@ -0,0 +1,22 @@
+const { Command } = require('commander')
+
+const agent = new Command('agent')
+
+agent
+  .description('🪪 agent')
+  .allowUnknownOption()
+
+// vestauth agent init
+const initAction = require('./../actions/agent/init')
+agent.command('init')
+  .description('create agent')
+  .option('-pp, --pretty-print', 'pretty print output')
+  .action(initAction)
+
+// vestauth agent hello
+const helloAction = require('./../actions/agent/hello')
+agent.command('hello')
+  .description('say hello')
+  .action(helloAction)
+
+module.exports = agent

package/src/cli/vestauth.js

@@ -38,6 +38,9 @@ program
   .version(packageJson.version)
   .allowUnknownOption()
 
+// dotenvx agent
+program.addCommand(require('./commands/agent'))
+
 // vestauth verifyAgent
 const verifyAgentAction = require('./actions/verifyAgent')
 program.command('verifyagent')

package/src/lib/agent.js

@@ -0,0 +1,7 @@
+const agentInit = require('./helpers/agentInit')
+const hello = require('./helpers/hello')
+
+module.exports = {
+  init: agentInit,
+  hello
+}

package/src/lib/helpers/agentInit.js

@@ -0,0 +1,30 @@
+const dotenvx = require('@dotenvx/dotenvx')
+const keypair = require('./keypair')
+const touch = require('./touch')
+
+const PUBLIC_KEYNAME = 'AGENT_PUBLIC_KEY'
+const PRIVATE_KEYNAME = 'AGENT_PRIVATE_KEY'
+
+function agentInit () {
+  const envPath = '.env'
+
+  // keypair
+  let currentPrivateKey = null
+  try { currentPrivateKey = dotenvx.get('AGENT_PRIVATE_KEY', { strict: true }) } catch (e) {}
+
+  const kp = keypair(currentPrivateKey, 'agent')
+
+  touch(envPath)
+
+  // place in .env file
+  dotenvx.set('AGENT_PUBLIC_KEY', kp.publicKey, { path: envPath, plain: true, quiet: true })
+  dotenvx.set('AGENT_PRIVATE_KEY', kp.privateKey, { path: envPath, plain: true, quiet: true })
+
+  return {
+    AGENT_PUBLIC_KEY: kp.publicKey,
+    AGENT_PRIVATE_KEY: kp.privateKey,
+    path: envPath
+  }
+}
+
+module.exports = agentInit

package/src/lib/helpers/hello.js

@@ -0,0 +1,5 @@
+function hello () {
+  return 'hello'
+}
+
+module.exports = hello

package/src/lib/helpers/touch.js

@@ -0,0 +1,7 @@
+const fs = require('fs')
+
+function touch (filepath) {
+  fs.closeSync(fs.openSync(filepath, 'a'))
+}
+
+module.exports = touch

package/src/lib/main.js

@@ -1,17 +1,9 @@
-const challenge = require('./helpers/challenge')
-const hash = require('./helpers/hash')
-const keypair = require('./helpers/keypair')
-const sign = require('./helpers/sign')
-const verify = require('./helpers/verify')
 const verifyAuthorizationHeader = require('./helpers/verifyAuthorizationHeader')
 const verifyAgent = require('./helpers/verifyAgent')
+const primitives = require('./primitives')
 
 module.exports = {
-  challenge,
-  hash,
-  keypair,
-  sign,
-  verify,
+  primitives,
   verifyAuthorizationHeader,
   verifyAgent
 }

package/src/lib/primitives.js

@@ -0,0 +1,13 @@
+const challenge = require('./helpers/challenge')
+const hash = require('./helpers/hash')
+const keypair = require('./helpers/keypair')
+const sign = require('./helpers/sign')
+const verify = require('./helpers/verify')
+
+module.exports = {
+  challenge,
+  hash,
+  keypair,
+  sign,
+  verify
+}