auth-request.ts File Reference

How a credential is sent — Phase 23, E16. More...

import type;

Include dependency graph for auth-request.ts:

Variables
export type	AuthScheme = 'bearer' | 'header' | 'basic' | 'query' | 'cookie'
	The ways a credential can be attached to a request.
export interface	AuthHeader
	One header, as a name and a value.
value	__pad0__

Detailed Description

How a credential is sent — Phase 23, E16.

@description The twin of unv-cli/src/authreq.rs, pinned by tests/fixtures/parity/auth-request.json and asserted from both sides.

Why this is a field and not a convention

How to send it is part of the credential, and it was nowhere in the model. Two entries holding the same-looking string are used completely differently: one goes in Authorization: Bearer, one in X-Api-Key, one in ?api_key=, one is the password half of HTTP basic. The vault knew the secret and not the one other thing you need in order to use it, so the user was left to remember which service wants which — and to get it wrong at 3am against an API that answers 401 either way.

auth_scheme + auth_param are what turn a stored string into a working request, and they are what the curl export needs anyway.

Shell quoting is not optional here

A cookie, a User-Agent or a password containing ‘’breaks-H '…', and the value is vault data, i.e. untrusted input (invariant 4).shellQuote` is POSIX single-quoting with the one escape that form allows, so a value can never end the quoted string and start a command.

Variable Documentation

AuthScheme

export type AuthScheme = 'bearer' | 'header' | 'basic' | 'query' | 'cookie'

The ways a credential can be attached to a request.

AuthHeader

export interface AuthHeader

Initial value:

{
  name: string

One header, as a name and a value.

__pad0__

value __pad0__