OpenQuizz
Une application de gestion des contenus pédagogiques
JSONWebSignatureSerializer Class Reference
Inheritance diagram for JSONWebSignatureSerializer:
Collaboration diagram for JSONWebSignatureSerializer:

Public Member Functions

def __init__ (self, secret_key, salt=None, serializer=None, serializer_kwargs=None, signer=None, signer_kwargs=None, algorithm_name=None)
 
def load_payload (self, payload, serializer=None, return_header=False)
 
def dump_payload (self, header, obj)
 
def make_algorithm (self, algorithm_name)
 
def make_signer (self, salt=None, algorithm=None)
 
def make_header (self, header_fields)
 
def dumps (self, obj, salt=None, header_fields=None)
 
def loads (self, s, salt=None, return_header=False)
 
def loads_unsafe (self, s, salt=None, return_header=False)
 
- Public Member Functions inherited from Serializer
def load_payload (self, payload, serializer=None)
 
def dump_payload (self, obj)
 
def make_signer (self, salt=None)
 
def iter_unsigners (self, salt=None)
 
def dumps (self, obj, salt=None)
 
def dump (self, obj, f, salt=None)
 
def loads (self, s, salt=None)
 
def load (self, f, salt=None)
 
def loads_unsafe (self, s, salt=None)
 
def load_unsafe (self, f, *args, **kwargs)
 

Data Fields

 algorithm_name
 
 algorithm
 
- Data Fields inherited from Serializer
 secret_key
 
 salt
 
 serializer
 
 is_text_serializer
 
 signer
 
 signer_kwargs
 
 fallback_signers
 
 serializer_kwargs
 

Static Public Attributes

 jws_algorithms
 
 default_algorithm
 
 default_serializer
 
- Static Public Attributes inherited from Serializer
 default_serializer
 
 default_signer
 
 default_fallback_signers
 

Detailed Description

This serializer implements JSON Web Signature (JWS) support. Only
supports the JWS Compact Serialization.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  secret_key,
  salt = None,
  serializer = None,
  serializer_kwargs = None,
  signer = None,
  signer_kwargs = None,
  algorithm_name = None 
)

Reimplemented from Serializer.

Member Function Documentation

◆ dump_payload()

def dump_payload (   self,
  header,
  obj 
)

◆ dumps()

def dumps (   self,
  obj,
  salt = None,
  header_fields = None 
)
Like :meth:`.Serializer.dumps` but creates a JSON Web
Signature. It also allows for specifying additional fields to be
included in the JWS header.

◆ load_payload()

def load_payload (   self,
  payload,
  serializer = None,
  return_header = False 
)

◆ loads()

def loads (   self,
  s,
  salt = None,
  return_header = False 
)
Reverse of :meth:`dumps`. If requested via ``return_header``
it will return a tuple of payload and header.

Reimplemented in TimedJSONWebSignatureSerializer.

◆ loads_unsafe()

def loads_unsafe (   self,
  s,
  salt = None,
  return_header = False 
)

◆ make_algorithm()

def make_algorithm (   self,
  algorithm_name 
)

◆ make_header()

def make_header (   self,
  header_fields 
)

◆ make_signer()

def make_signer (   self,
  salt = None,
  algorithm = None 
)

Field Documentation

◆ algorithm

algorithm

◆ algorithm_name

algorithm_name

◆ default_algorithm

default_algorithm
static

◆ default_serializer

default_serializer
static

◆ jws_algorithms

jws_algorithms
static

The documentation for this class was generated from the following file: