README

@satoshipay/stellar-sep-10

Stellar Ecosystem Proposal 10 - "Stellar Web Authentication" client SDK, allowing Stellar wallets to authenticate for a web service using an account's private key.

Note: This package is still considered experimental. Breaking changes should be expected.

Installation

npm install @satoshipay/stellar-sep-10
# or with yarn:
yarn add @satoshipay/stellar-sep-10

Usage

Digest remote stellar.toml information

// Look up the stellar.toml for an issuing account, parse it, return data
import { Server } from "stellar-sdk"
import { fetchWebAuthData } from "@satoshipay/stellar-sep-10"

const horizon = new Server("https://stellar-horizon.satoshipay.io/")
const issuingAccountID =
  "GABWHTAVRYF2MCNDR5YC5SC3JTZQBGDZ3HKI4QAREV5533VU43W4HJUX"

const webauth = fetchWebAuthData(horizon, issuingAccountID)
// typeof webauth = { endpointURL: string, signingKey: string } | undefined

Alternatively, if you already fetched and parsed the stellar.toml file:

import {
  getServiceSigningKey,
  getWebAuthEndpointURL
} from "@satoshipay/stellar-sep-10"

const stellarToml = {
  // Parsed stellar.toml content fetched from remote...
}

const endpointURL = getWebAuthEndpointURL(stellarToml)
const signingKey = getServiceSigningKey(stellarToml)

Authenticate - The simple way

import { Keypair } from "stellar-sdk"
import { authenticate } from "@satoshipay/stellar-sep-10"

// see above how to obtain `webauth`
const accountKeypair = Keypair.fromSecret("S...")

const jwt = await authenticate(
  webauth.endpointURL,
  webauth.signingKey,
  accountKeypair,
  Network.current()
)

You can now use jwt in HTTP requests for authentication. Use the Authorization header:

Authorization: Bearer ${jwt}

Authenticate - The manual way

import { Keypair } from "stellar-sdk"
import { authenticate } from "@satoshipay/stellar-sep-10"

// see above how to obtain `webauth`
const accountKeypair = Keypair.fromSecret("S...")

const transaction = await fetchChallenge(
  webauth.endpointURL,
  webauth.signingKey,
  accountKeypair.publicKey()
)

transaction.sign(accountKeypair)

const jwt = await postResponse(webauth.endpointURL, transaction)

Use this slightly less convenient way if you want the user to review the transaction before signing it.

License

GPL v3

Usage no npm install needed!