jwt_object_grp(3)

📦
version 3.3.3 · 2 versions
, in ubuntu stonking

💖 jwt_object_grp(3) — the JWT functions page, bestie edition 💖

okay so this is a page from the Library Functions Manual (that's the 3 in jwt_object_grp(3), iykyk) and it's literally all about the LibJWT object group: the structs, the typedefs, and the six little functions that let you poke at a JWT's header and claims. pull up a chair, we're doing this together 🫶

✨ NAME ✨

jwt_object_grp — JWT Functions

like. the JWT functions. the whole squad. periodt.

🌸 SYNOPSIS 🌸

🎀 Data Structures

  • struct jwt_config_t — Structure used to pass state with a user callback.

🦋 Typedefs

  • typedef struct jwt jwt_t — Opaque JWT object.
  • typedef int(* jwt_callback_t) (jwt_t *, jwt_config_t *) — General callback for generation and verification of JWT.

💅 Functions

jwt_value_error_t jwt_header_set (jwt_t *jwt, jwt_value_t *value)
    Set a value in the header of a JWT.
jwt_value_error_t jwt_header_get (jwt_t *jwt, jwt_value_t *value)
    Get a value from the header of a JWT.
jwt_value_error_t jwt_header_del (jwt_t *jwt, const char *header)
    Delete a value from the header of a JWT.
jwt_value_error_t jwt_claim_set (jwt_t *jwt, jwt_value_t *value)
    Set a value in the claims of a JWT.
jwt_value_error_t jwt_claim_get (jwt_t *jwt, jwt_value_t *value)
    Get a value from the claims of a JWT.
jwt_value_error_t jwt_claim_del (jwt_t *jwt, const char *claim)
    Delete a value from the claims of a JWT.

👑 Detailed Description 👑

okay so here's the tea ☕ — for most usage, setting values in the builder object is enough to provide all the information you would like set in a JWT token. easy. iconic. no notes.

but — and this is the plot twist 🫢 — if some information is dynamic, meaning it is only known at the time the token is created, then you can provide this during the builder callback on the jwt_t object. that's the whole point of the callback, bestie. live wiring. real-time vibes. ✨

⚠️ important, no cap: when verifying a token, the checker callback should not modify the jwt_t object at all. like, do not touch. hands off. 🙅‍♀️

the reason access to the jwt_t is provided at all is only to allow additional validation beyond LibJWT's internal checks. that's it. that's the assignment. 💜

🧚 Typedef Documentation 🧚

typedef int(* jwt_callback_t) (jwt_t *, jwt_config_t *)

General callback for generation and verification of JWT.

typedef struct jwt jwt_t

Opaque JWT object. Used in callbacks when generating or verifying a JWT.

🔥 Function Documentation 🔥

jwt_value_error_t jwt_claim_del (jwt_t * jwt, const char * claim)

Delete a value from the claims of a JWT. bye girl, we don't need you 👋

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • claim — The name of the claim to delete, or NULL to clear all claims

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success.

jwt_value_error_t jwt_claim_get (jwt_t * jwt, jwt_value_t * value)

Get a value from the claims of a JWT. reading the receipts 🧾✨

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • value — A jwt_value_t structure with relevant actions filled in

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success. The value.error field will match this return value. (yes bestie, they're matching. twin behavior. 👯)

jwt_value_error_t jwt_claim_set (jwt_t * jwt, jwt_value_t * value)

Set a value in the claims of a JWT. putting a lil something in there 💅

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • value — A jwt_value_t structure with relevant actions filled in

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success. The value.error field will match this return value.

jwt_value_error_t jwt_header_del (jwt_t * jwt, const char * header)

Delete a value from the header of a JWT. decluttering era 🌈

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • header — The name of the header to delete, or NULL to clear the entire header
🫢 passing NULL here wipes the entire header, not just one field. know that before you do it, fr fr.

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success.

jwt_value_error_t jwt_header_get (jwt_t * jwt, jwt_value_t * value)

Get a value from the header of a JWT. peeking at the top of the token, respectfully 🙈

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • value — A jwt_value_t structure with relevant actions filled in

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success. The value.error field will match this return value.

jwt_value_error_t jwt_header_set (jwt_t * jwt, jwt_value_t * value)

Set a value in the header of a JWT. main character energy, in the header this time 👑

Parameters

  • jwt — Pointer to a jwt_t token, previously created with jwt_create()
  • value — A jwt_value_t structure with relevant actions filled in

Returns

  • A jwt_value_error_t value, JWT_VALUE_ERR_NONE being success. The value.error field will match this return value.

💜 Author 💜

Generated automatically by Doxygen for LibJWT from the source code.

(so like, no human wrote this, a robot did. and honestly? slay, doxygen. 🤖✨)

and that's the whole page, bestie 🎀 mwah. this was LibJWT, Version 3.3.3 — shoutout to the source code for making it all happen, and to jwt_object_grp(3) for being the section we all came here for. go forth and set those claims, but remember: don't modify the jwt_t during verification, or it's giving chaos 😭💖

📦 where this page comes from