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

@synonymdev/slashtags-auth

v1.0.0-alpha.6

Published

P2P authorization and bidirectional authentication with holepunching through Hyperswarm.

Downloads

1,678

Readme

slashtags-auth

P2P authorization and bidirectional authentication with holepunching through Hyperswarm.

Installation

npm install @synonymdev/slashtags-auth

Usage

Server side

import SDK from '@synonymdev/slashtags-sdk'
import { Server } from '@synonymdev/slashtags-auth'

const sdk = new SDK({ primaryKey: <32 bytes secret key> })

const slashtag = sdk.slashtag()

const server = new Server(slashtag, {
    onauthz: (token, remote) => {
      // Check that token is valid, and remote isn't blocked
      return { status: 'ok', resources: [] }
    },
    onmagiclink: (remote) => {
        return 'https://www.example.com?q=foobar'
    }
})

const slashauthURL = server.fromatURL(token)

Client side

import SDK from '@synonymdev/slashtags-sdk'
import { Client } from '@synonymdev/slashtags-auth'

const sdk = new SDK({ primaryKey: <32 bytes secret key> })

const slashtag = sdk.slashtag()

const client = new Client(slashtag)

// Authorize an app by scanning a slashauth: url
const response = client.authz(url)
// true or false

// Request a magicLink from the server's slashtag url
const link =  client.magiclik(url)

How does it work

authz

1- Server announces its IP and port on Hyperswarm DHT. 2- Server formats its publicKey as slashauth:<zbase32 publicKey>?q=<token> where token is an represents either a session id, or client id or any internal identification of the Client it should send requested resources to. 3- Client shows the url as a QR code to the Wallet. 4- Wallet parses the url and optain the Server's publicKey and client token. 5- Wallet queries the DHT for the Server's IP and port using its public key. 6- Wallet establishes a secure connection with thes Server, confirming its publicKey, and pass the token to auhtorize the Client. 7- Server verifies the token, and confirms the success to the client. In parallel, the server now knows the Wallet publicKey and can save it in its users table / collection. 8- Finally Server grants Client the requested resources started a logged in session.

+-----------+   +-----------+   +-----------+   +-----------+       
|    DHT    |   |  Server   |   |  Client   |   |   Wallet  |       
+-----------+   +-----------+   +-----------+   +-----------+       
      |               |               |               |             
      |   Announce    |               |               |             
      |<--------------|               |               |             
      |               |               |               |             
      |               | slashauth:... |               |             
      |               |-------------->|               |             
      |               |               |               |             
      |               |               | slashauth:... |             
      |               |               |-------------->|             
      |               |               |               |----+ parse  
      |               |               |               |    | key +  
      |               |               |               |    | token  
      |               |     Query     |               |<---+        
      |<----------------------------------------------|             
      |               |               |               |             
      |               Server IP + port|               |             
      |---------------------------------------------->|             
      |               |               |               |             
                      |      Connect + send token     |             
                      |<------------------------------|             
                  +---|               |               |             
          Verify  |   |               |               |             
          token   |   |               |               |             
                  +-->|               |               |             
                      |        Confirm success        |             
                      |------------------------------>|             
                      |               |               |             
                      |send resources |               |             
                      |-------------->|               |             
                      |               |               |             

magiclink

Magiclink functionality helps wallets get a one-time passwordless link to login to a website, that it previously authenticated to.

1- Wallet queries the DHT for the current IP and port number for the server's publicKey. 2- Wallet connects to the Server and requests a magic link. 3- Server compares the publicKey the request is coming form, with its internal DB. 4- If the Server gants the request, it will respond with a one-time link that Wallet can use to redirect the user to an already logged in session in browser.

+-----------+   +-----------+               +-----------+                    
|    DHT    |   |  Server   |               |   Wallet  |                    
+-----------+   +-----------+               +-----------+                    
      |               |                           |                          
      |   Announce    |                           |                          
      |<--------------|                           |                          
      |               |                           |                          
      |               |     Query                 |                          
      |<------------------------------------------|                          
      |               |                           |                          
      |               Server IP + port            |                          
      |------------------------------------------>|                          
                      |                           |                          
                      |   Request magiclink       |                          
                      |<--------------------------|                          
                      |                           |                          
                      |One time passwordless link |                          
                      |-------------------------->|                          
                      |                           |