feisty meow concerns codebase  2.140
cromp::cromp_security Class Reference

Implements the client registry in a cromp-appropriate manner. More...

#include <cromp_security.h>

Inheritance diagram for cromp::cromp_security:
Collaboration diagram for cromp::cromp_security:

Public Member Functions

 cromp_security ()
 
virtual ~cromp_security ()
 
 DEFINE_CLASS_NAME ("cromp_security")
 
virtual bool add_entity (const octopi::octopus_entity &client, const basis::byte_array &verification)
 adds the "entity" to the list of authorized users. More...
 
- Public Member Functions inherited from octopi::simple_entity_registry
 simple_entity_registry ()
 
virtual ~simple_entity_registry ()
 
virtual bool authorized (const octopus_entity &entity)
 returns true if the "entity" is a registered and authorized entity. More...
 
virtual bool locate_entity (const octopus_entity &entity, timely::time_stamp &last_active, basis::byte_array &verification)
 retrieves the "security_record" for the "entity" if it exists. More...
 
virtual bool refresh_entity (const octopus_entity &entity)
 this should be used to refresh the entity's health record. More...
 
virtual bool zap_entity (const octopus_entity &entity)
 removes an "entity" if the entity can be found. More...
 
virtual basis::astring text_form ()
 shows the contents of the registry. More...
 
- Public Member Functions inherited from octopi::entity_registry
 entity_registry ()
 
virtual ~entity_registry ()
 

Detailed Description

Implements the client registry in a cromp-appropriate manner.

The identity issue request is vetted against the known connection endpoint for a client.

Definition at line 27 of file cromp_security.h.

Constructor & Destructor Documentation

◆ cromp_security()

cromp::cromp_security::cromp_security ( )

Definition at line 37 of file cromp_security.cpp.

◆ ~cromp_security()

cromp::cromp_security::~cromp_security ( )
virtual

Definition at line 42 of file cromp_security.cpp.

References basis::WHACK().

Member Function Documentation

◆ add_entity()

bool cromp::cromp_security::add_entity ( const octopi::octopus_entity entity,
const basis::byte_array verification 
)
virtual

adds the "entity" to the list of authorized users.

note that this will still succeed if the entity is already present, allowing it to serve as an entity refresh method. if the "verification" has any length, it will be stored in the record for the "entity".

Reimplemented from octopi::simple_entity_registry.

Definition at line 47 of file cromp_security.cpp.

References FUNCDEF, LOG, and octopi::octopus_entity::mangled_form().

◆ DEFINE_CLASS_NAME()

cromp::cromp_security::DEFINE_CLASS_NAME ( "cromp_security"  )

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