SECSIPIDX(1)

<h1># secsipidx ✨</h1>

okay so bestie, welcome to section 1 of the General Commands Manual, and it's literally all about secsipidx β€” the CLI tool and HTTP API server that checks or builds your SIP identity headers. It's giving "small tool, big STIR/SHAKEN energy" and honestly? obsessed. πŸ’…


🌸 NAME 🌸

secsipidx β€” a CLI tool and HTTP API server to check or build SIP identity headers. that's it, that's the whole vibe, no cap πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

secsipidx [options]

✨ DESCRIPTION ✨

okay so picture this: it's a command line application whose whole main character job is to check or build SIP identity headers as per IETF RFC8224 and RFC8588 β€” yes bestie, that's STIR and SHAKEN. πŸ”₯

and it can also be run in daemon mode, serving up an HTTP REST API so that external applications can adopt STIR and SHAKEN without breaking a sweat. fr fr, it's out here making everyone's life easier. 🫢


πŸ’… OPTIONS πŸ’…

okay bestie, here comes the whole list. every single one. hydrate first. πŸ’–

  • -H, -http-srv β€” http server bind address
  • -https-srv β€” https server bind address
  • -https-pubkey β€” https server public key
  • -https-prvkey β€” https server private key
  • -http-dir β€” directory to serve over http
  • -k, -fprvkey β€” path to private key
  • -p, -fpubkey β€” path to public key
  • -fheader β€” path to file with header value in JSON format
  • -header β€” header value in JSON format
  • -fpayload β€” path to file with payload value in JSON format
  • -payload β€” payload value in JSON format
  • -fidentity β€” path to file with identity value
  • -identity β€” identity value
  • -alg β€” encryption algorithm (default: ES256)
  • -ppt β€” used extension (default: shaken)
  • -typ β€” token type (default: passport)
  • -x5u β€” value of the field with the location of the certificate used to sign the token (default: '')
  • -a, -attest β€” attestation level (default: 'C')
  • -d, -dest-tn β€” destination (called) number (default: '')
  • -o, -orig-th β€” origination (calling) number (default: '')
  • -iat β€” timestamp when the token was created
  • -orig-id β€” origination identifier (default: '')
  • -c, -check β€” check validity of the signature
  • -s, -sign β€” sign the header and payload
  • -S, -sign-full β€” sign the header and payload, with parameters
  • -json-parse β€” parse and re-serialize JSON header and payaload values
  • -expire β€” duration of token validity (in seconds)
  • -timeout β€” http get timeout (in seconds, default: 3)
  • -l, -ltest β€” run local basic test
  • -version β€” print version
  • -cache-dir β€” path to the directory with cached certificates (default: '')
  • -cache-expire β€” duration of cached certificates (in seconds, default 3600)
  • -ca-file β€” file with root CA certificates in pem format
  • -ca-inter β€” file with intermediate CA certificates in pem format
  • -cert-verify β€” certificate verification mode (default: 0)
  • -crl-file β€” file with CRL

πŸŽ€ EXAMPLES πŸŽ€

TODO

bestie I'm not gonna lie, that's literally what it says. the examples section is a TODO. we wait. πŸ’€

πŸ‘‘ AUTHOR πŸ‘‘

This manual page was written by Victor Seva <vseva@debian.org>, for the Debian project (and may be used by others). πŸ’œ iconic behavior honestly.


and that's the whole page bestie!! this one's dated 2021-01-07, it's the SECSIPIDX(1) page, straight out of the General Commands Manual β€” so go forth and check/build those SIP identity headers. slay. πŸ¦‹βœ¨πŸŽ€