Index

A

access_control (foca.models.config.SecurityConfig attribute), [1] AccessControlConfig (class in foca.models.config) Adapter (class in foca.security.access_control.foca_casbin_adapter.adapter) add_key_to_claims (foca.models.config.AuthConfig attribute), [1] add_new_database() (in module foca.database.register_mongodb) add_operation_fields (foca.models.config.SpecConfig attribute), [1] add_policy() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) add_security_fields (foca.models.config.SpecConfig attribute), [1] algorithms (foca.models.config.AuthConfig attribute), [1] all (foca.models.config.ValidationChecksEnum attribute), [1]

allow_expired (foca.models.config.AuthConfig attribute), [1] any (foca.models.config.ValidationChecksEnum attribute), [1] api (foca.models.config.Config attribute), [1] api_controllers (foca.models.config.AccessControlConfig attribute), [1] api_specs (foca.models.config.AccessControlConfig attribute), [1] APIConfig (class in foca.models.config) append (foca.models.config.SpecConfig attribute), [1] ASCENDING (foca.models.config.PymongoDirectionEnum attribute), [1] audience (foca.models.config.AuthConfig attribute), [1] auth (foca.models.config.SecurityConfig attribute), [1] AuthConfig (class in foca.models.config)

B

backend (foca.models.config.JobsConfig attribute), [1]

C

CasbinRule (class in foca.security.access_control.foca_casbin_adapter.casbin_rule) check_permissions() (in module foca.security.access_control.register_access_control) claim_identity (foca.models.config.AuthConfig attribute), [1] claim_issuer (foca.models.config.AuthConfig attribute), [1] class (foca.models.config.LogFormatterConfig attribute) (foca.models.config.LogHandlerConfig attribute) class_formatter (foca.models.config.LogFormatterConfig attribute) class_handler (foca.models.config.LogHandlerConfig attribute) client (foca.models.config.CollectionConfig attribute), [1] (foca.models.config.DBConfig attribute), [1] collection (foca.security.access_control.foca_casbin_adapter.adapter.Adapter attribute) collection_name (foca.models.config.AccessControlConfig attribute), [1]

CollectionConfig (class in foca.models.config) collections (foca.models.config.DBConfig attribute), [1] Config (class in foca.models.config) config_file (foca.config.config_parser.ConfigParser attribute) ConfigParser (class in foca.config.config_parser) connexion (foca.models.config.SpecConfig attribute), [1] cors (foca.models.config.SecurityConfig attribute), [1] CORSConfig (class in foca.models.config) create_app() (foca.foca.Foca method) create_celery_app() (foca.foca.Foca method) (in module foca.factories.celery_app) create_connexion_app() (in module foca.factories.connexion_app) custom_config_model (foca.config.config_parser.ConfigParser attribute)

D

db (foca.models.config.Config attribute), [1] db_name (foca.models.config.AccessControlConfig attribute), [1] DBConfig (class in foca.models.config) dbname (foca.security.access_control.foca_casbin_adapter.adapter.Adapter attribute) dbs (foca.models.config.MongoConfig attribute), [1]

debug (foca.models.config.ServerConfig attribute), [1] deletePermission() (in module foca.security.access_control.access_control_server) DESCENDING (foca.models.config.PymongoDirectionEnum attribute), [1] dict() (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule method) disable_auth (foca.models.config.SpecConfig attribute), [1] disable_existing_loggers (foca.models.config.LogConfig attribute), [1]

E

enable_cors() (in module foca.security.cors) enabled (foca.models.config.CORSConfig attribute), [1] environment (foca.models.config.ServerConfig attribute), [1] ExceptionConfig (class in foca.models.config)

ExceptionLoggingEnum (class in foca.models.config) exceptions (foca.models.config.Config attribute), [1] (foca.models.config.ExceptionConfig attribute), [1] extension_members (foca.models.config.ExceptionConfig attribute), [1]

F

find_id_latest() (in module foca.utils.db) find_one_latest() (in module foca.utils.db) foca module Foca (class in foca.foca) foca.api module foca.api.register_openapi module foca.config module foca.config.config_parser module foca.database module foca.database.register_mongodb module foca.errors module foca.errors.exceptions module foca.factories module foca.factories.celery_app module foca.factories.connexion_app module foca.foca module foca.models module foca.models.config module foca.security module

foca.security.access_control module foca.security.access_control.access_control_server module foca.security.access_control.api module foca.security.access_control.constants module foca.security.access_control.foca_casbin_adapter module foca.security.access_control.foca_casbin_adapter.adapter module foca.security.access_control.foca_casbin_adapter.casbin_rule module foca.security.access_control.register_access_control module foca.security.auth module foca.security.cors module foca.utils module foca.utils.db module foca.utils.logging module foca.utils.misc module foca.version module FOCABaseConfig (class in foca.models.config) format (foca.models.config.LogFormatterConfig attribute), [1] format_logs (foca.config.config_parser.ConfigParser attribute) formatter (foca.models.config.LogHandlerConfig attribute), [1] formatters (foca.models.config.LogConfig attribute), [1]

G

generate_id() (in module foca.utils.misc) GEO2D (foca.models.config.PymongoDirectionEnum attribute), [1] GEOHAYSTACK (foca.models.config.PymongoDirectionEnum attribute), [1]

GEOSPHERE (foca.models.config.PymongoDirectionEnum attribute), [1] getAllPermissions() (in module foca.security.access_control.access_control_server) getPermission() (in module foca.security.access_control.access_control_server)

H

handlers (foca.models.config.LogConfig attribute), [1] (foca.models.config.LogRootConfig attribute), [1] HASHED (foca.models.config.PymongoDirectionEnum attribute), [1]

host (foca.models.config.JobsConfig attribute), [1] (foca.models.config.MongoConfig attribute), [1] (foca.models.config.ServerConfig attribute), [1]

I

include (foca.models.config.JobsConfig attribute), [1]

IndexConfig (class in foca.models.config) indexes (foca.models.config.CollectionConfig attribute), [1]

J

jobs (foca.models.config.Config attribute), [1]

JobsConfig (class in foca.models.config)

K

keys (foca.models.config.IndexConfig attribute), [1]

L

level (foca.models.config.LogHandlerConfig attribute), [1] (foca.models.config.LogRootConfig attribute), [1] load_policy() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) log (foca.models.config.Config attribute), [1] log_traffic() (in module foca.utils.logging)

LogConfig (class in foca.models.config) LogFormatterConfig (class in foca.models.config) logging (foca.models.config.ExceptionConfig attribute), [1] LogHandlerConfig (class in foca.models.config) LogRootConfig (class in foca.models.config)

M

make_paths_absolute_and_set_path_out() (foca.models.config.SpecConfig method) mapping (foca.models.config.ExceptionConfig attribute), [1] merge_yaml() (foca.config.config_parser.ConfigParser static method) minimal (foca.models.config.ExceptionLoggingEnum attribute), [1] model (foca.models.config.AccessControlConfig attribute), [1] model_config (foca.models.config.AccessControlConfig attribute) (foca.models.config.APIConfig attribute) (foca.models.config.AuthConfig attribute) (foca.models.config.CollectionConfig attribute) (foca.models.config.Config attribute) (foca.models.config.CORSConfig attribute) (foca.models.config.DBConfig attribute) (foca.models.config.ExceptionConfig attribute) (foca.models.config.FOCABaseConfig attribute) (foca.models.config.IndexConfig attribute) (foca.models.config.JobsConfig attribute) (foca.models.config.LogConfig attribute) (foca.models.config.LogFormatterConfig attribute) (foca.models.config.LogHandlerConfig attribute) (foca.models.config.LogRootConfig attribute) (foca.models.config.MongoConfig attribute) (foca.models.config.SecurityConfig attribute) (foca.models.config.ServerConfig attribute) (foca.models.config.SpecConfig attribute) module foca foca.api foca.api.register_openapi foca.config foca.config.config_parser foca.database foca.database.register_mongodb foca.errors foca.errors.exceptions foca.factories foca.factories.celery_app foca.factories.connexion_app foca.foca foca.models foca.models.config foca.security foca.security.access_control foca.security.access_control.access_control_server foca.security.access_control.api foca.security.access_control.constants foca.security.access_control.foca_casbin_adapter foca.security.access_control.foca_casbin_adapter.adapter foca.security.access_control.foca_casbin_adapter.casbin_rule foca.security.access_control.register_access_control foca.security.auth foca.security.cors foca.utils foca.utils.db foca.utils.logging foca.utils.misc foca.version

MongoConfig (class in foca.models.config)

N

none (foca.models.config.ExceptionLoggingEnum attribute), [1]

O

oneline (foca.models.config.ExceptionLoggingEnum attribute), [1]

options (foca.models.config.IndexConfig attribute), [1] owner_headers (foca.models.config.AccessControlConfig attribute), [1]

P

parse_custom_config() (foca.config.config_parser.ConfigParser method) parse_yaml() (foca.config.config_parser.ConfigParser static method) path (foca.models.config.SpecConfig attribute), [1] path_out (foca.models.config.SpecConfig attribute), [1] port (foca.models.config.JobsConfig attribute), [1] (foca.models.config.MongoConfig attribute), [1] (foca.models.config.ServerConfig attribute), [1]

postPermission() (in module foca.security.access_control.access_control_server) private_members (foca.models.config.ExceptionConfig attribute), [1] ptype (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) public_key (foca.models.config.ValidationMethodsEnum attribute), [1] public_members (foca.models.config.ExceptionConfig attribute), [1] putPermission() (in module foca.security.access_control.access_control_server) PymongoDirectionEnum (class in foca.models.config)

R

register_access_control() (in module foca.security.access_control.register_access_control) register_casbin_enforcer() (in module foca.security.access_control.register_access_control) register_exception_handler() (in module foca.errors.exceptions) register_mongodb() (in module foca.database.register_mongodb) register_openapi() (in module foca.api.register_openapi) register_permission_specs() (in module foca.security.access_control.register_access_control)

regular (foca.models.config.ExceptionLoggingEnum attribute), [1] remove_filtered_policy() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) remove_policy() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) required (foca.models.config.AuthConfig attribute), [1] required_members (foca.models.config.ExceptionConfig attribute), [1] root (foca.models.config.LogConfig attribute), [1]

S

save_policy() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) save_policy_line() (foca.security.access_control.foca_casbin_adapter.adapter.Adapter method) security (foca.models.config.Config attribute), [1] SecurityConfig (class in foca.models.config) server (foca.models.config.Config attribute), [1] ServerConfig (class in foca.models.config)

SpecConfig (class in foca.models.config) specs (foca.models.config.APIConfig attribute), [1] status_member (foca.models.config.ExceptionConfig attribute), [1] store_enum_value() (foca.models.config.IndexConfig class method) stream (foca.models.config.LogHandlerConfig attribute), [1] style (foca.models.config.LogFormatterConfig attribute), [1]

T

testing (foca.models.config.ServerConfig attribute), [1]

TEXT (foca.models.config.PymongoDirectionEnum attribute), [1]

U

uri (foca.security.access_control.foca_casbin_adapter.adapter.Adapter attribute) use_reloader (foca.models.config.ServerConfig attribute), [1]

user_headers (foca.models.config.AccessControlConfig attribute), [1] userinfo (foca.models.config.ValidationMethodsEnum attribute), [1]

V

v0 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) v1 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) v2 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) v3 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) v4 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) v5 (foca.security.access_control.foca_casbin_adapter.casbin_rule.CasbinRule attribute) validate_exceptions_mapping() (foca.models.config.ExceptionConfig method)

validate_model_path() (foca.models.config.AccessControlConfig class method) validate_token() (in module foca.security.auth) validation_checks (foca.models.config.AuthConfig attribute), [1] validation_methods (foca.models.config.AuthConfig attribute), [1] ValidationChecksEnum (class in foca.models.config) ValidationMethodsEnum (class in foca.models.config) version (foca.models.config.LogConfig attribute), [1]