/webauthn

A set of tools for building an API and interacts with WebAuthn

Primary LanguageTypeScript

@artifact-project/webauthn

A set of tools for building an API and interacts with WebAuthn.

Credential Create Request (aka Registration)

import {
	credentials,
	createMultiPhaseRequest,
	fetchJSON,
	parseAsCredentialCreationOptionsAndExtra,
	encodeAttestationResponsePayload,
} from '@artifact-project/webauthn';

const credentialCreateRequest = createMultiPhaseRequest<{login: params}>()
	.phase((params) => fetchJSON('/api/v1/webauthn/credentials/create', params)
		.then(res => res.body)
		.then(parseAsCredentialCreationOptionsAndExtra)
	)
	.phase(({options, extra}) => credentials.create(options).then(credential => ({
		extra,
		options,
		credential,
	})))
	.phase(
		({extra, credential, options}) => fetchJSON('/api/v1/webauthn/credentials/create/confirm', {
			...extra,
			attestation: encodeAttestationResponsePayload(credential),
		}).then(res => ({
			extra: res.body,
			options,
			credential,
		}))
	)
;

credentialCreateRequest({
	login: 'ibn@rubaxa.org',
}).then(console.log);
// {
//   extra: {id: "...", login: "ibn@rubaxa.org"},
//   options: {...},
//   credential: {...},
// }

Credential Request (aka Login)

import {
	credentials,
	createMultiPhaseRequest,
	fetchJSON,
	parseAsCredentialRequestOptionsAndExtra,
	encodeAssertionResponsePlayload,
} from '@artifact-project/webauthn';

const credentialRequest = createMultiPhaseRequest<{login: params}>()
	.phase((params) => fetchJSON('/api/v1/webauthn/credentials/get', params)
		.then(res => res.body)
		.then(parseAsCredentialRequestOptionsAndExtra)
	)
	.phase(({options, extra}) => credentials.get(options).then(credential => ({
		extra,
		options,
		credential,
	})))
	.phase(
		({extra, credential, options}) => fetchJSON('/api/v1/webauthn/credentials/get/confirm', {
			...extra,
			assertion: encodeAssertionResponsePlayload(credential),
		}).then(res => ({
			extra: res.body,
			options,
			credential,
		}))
	)
;

credentialRequest({
	login: 'ibn@rubaxa.org',
}).then(console.log);
// {
//   extra: {token: "...", url: "...", expires: 123},
//   options: {...},
//   credential: {...},
// }

API

  • isWebauthnSupported(): boolean
  • credentials
    • hasKeys(): 'probably' | 'maybe' | ''
    • revokeKeys(): void
    • create(options?: CredentialCreationOptions): Promise<CredentialType|null>
    • get(options?: CredentialRequestOptions): Promise<CredentialType|null>
  • createPhaseRequest<P extends object>(): (params: P) => Promise<R>
  • fetchJSON(url: string, params: object): Response
  • Decode
    • decodeBuffer(value: string): ArrayBuffer
    • decodePublicKeyCredentialCreationOptions(value: object): PublicKeyCredentialCreationOptions
    • decodePublicKeyCredentialRequestOptions(value: object): PublicKeyCredentialRequestOptions
    • decodeCredentialCreationOptions(value: object): CredentialCreationOptions
    • decodeCredentialRequestOptions(value: object): CredentialRequestOptions
  • Encode
    • encodeBuffer(buffer: ArrayBuffer): string
    • encodeAttestationResponsePayload(credential: PublicKeyCredential): EncodedPublicKeyCredential
    • encodeAssertionResponsePlayload(credential: PublicKeyCredential): EncodedPublicKeyCredential

Development