npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@seneca/apikey

v0.1.0

Published

Apikey management plugin for Seneca

Downloads

4

Readme

Seneca

A Seneca.js plugin for providing API keys.

@seneca/apikey

npm version Build Status Coverage Status Maintainability DeepScan grade Dependency Status Gitter

| Voxgig | This open source module is sponsored and supported by Voxgig. | |---|---|

Description

This module is a plugin for the Seneca framework. It provides common actions for supplying API keys to external clients.

API keys are generated and hashed to the same level as passwords.

Install

npm install seneca
npm install seneca-promisify // dependency
npm install seneca-entity // dependency
npm install @seneca/user // dependency
npm install @seneca/apikey

Quick example

Register a apikey and then create an automatic login for testing.

const Seneca = require('seneca')

var seneca = Seneca()
  .use('promisify')
  .use('entity')
  .use('apikey')

// TODO: complete quick example

Detailed Examples

Because Seneca treats messages as first-class citizens, 90% of unit testing can be implemented with message scenarios that also provide detailed usage examples:

Options

  • test : boolean false
  • keysize : number 32
  • tagsize : number 8
  • rounds : number 11
  • salt.bytelen : number 16
  • salt.format : string "hex"
  • pepper : string ""
  • generate_salt : function generate_salt

Set plugin options when loading with:



seneca.use('apikey', { name: value, ... })

Note: foo.bar in the list above means { foo: { bar: ... } }

Action Patterns

Action Descriptions

« sys:apikey,generate:key »

Generate a new API key.

Parameters

  • owner : string " "
  • scope : string "default"

Replies With

{
  ok: '`true` if successful',
  key: 'key string'
}

« sys:apikey,verify:key »

Verify an API key.

Parameters

  • owner : string " "
  • scope : string "default"
  • key : string " "

Replies With

{
  ok: '`true` if verified',
  why: 'explanation code'
}

License

Copyright (c) 2010-2020, Richard Rodger and other contributors. Licensed under MIT.