secure logger

Logger seguro

Um decorador de Python para gerar entradas de tronco redigidas e bem formatadas. Funciona em todas as chamáveis: classe, métodos de classe, funções do módulo Python. Reduzir recursivamente os valores-chave do Dicionário Python com base em uma lista personalizável de chaves insensíveis ao caso. Impede que seus dados de aplicativos sensíveis, como os pares de teclas do provedor de nuvem, vazem para os logs de aplicativos.

Instalação

pip install secure-logger

Uso

Como decorador

 from secure_logger . decorators import secure_logger
import logging

logging . getLogger ( __name__ )
logging . basicConfig ( level = logging . INFO )

class Foo ( object ):
    @ secure_logger ( log_level = 'INFO' )
    def bar ( self , dict_data , list_data ):
        pass

# call your method, passing some sensitive data
dict_data = {
    "not_a_sensitive_key" : "you-can-see-me" ,
    "aws-access-key-id" : "i-am-hidden" ,
    "aws-secret-access-key" : "so-am-i" ,
}
list_data = [ "foo" , "bar" ]
foo = Foo ()
foo . bar ( dict_data = dict_data , list_data = list_data )

Saída de log:

 INFO:secure_logger: __main__.bar() ['<__main__.Foo object at 0x103474ac0>'] keyword args: {
    "dict_data": {
        "not_a_sensitive_key": "you-can-see-me",
        "aws-access-key-id": "*** -- secure_logger() -- ***",
        "aws-secret-access-key": "*** -- secure_logger() -- ***"
    },
    "list_data": [
        "foo",
        "bar"
    ]

Como funções da biblioteca

 from secure_logger . masked_dict import masked_dict , masked_dict2str

dict_data = {
    'not_a_sensitive_key' : 'you-can-see-me' ,
    'aws-access-key_id' : conf . AWS_ACCESS_KEY_ID ,
    'aws-secret-access-key' : conf . AWS_SECRET_ACCESS_KEY
}
print ( masked_dict2str ( dict_data ))

Saída:

{
    " not_a_sensitive_key " : " you-can-see-me " ,
    " aws-access-key-id " : " *** -- secure_logger() -- *** " ,
    " aws-secret-access-key " : " *** -- secure_logger() -- *** "
}

Configuração

Secure_logger aceita parâmetros opcionais que você pode configurar como variáveis ​​de ambiente Bash ou com um arquivo .env colocado na raiz do seu projeto

• Secure_logger_sensitive_keys : uma lista de teclas de dicionário Python. Não é sensível ao caso.
• Secure_logger_redaction_message : um valor de string que substituirá os valores da chave sensível
• Secure_Logger_indentation : Número de caracteres para recuperar a saída da String JSON ao sair da saída
• Secure_Logger_Log_Level : o nível no qual o Secure_Logger gera entradas de log. Um dos: 'crítico', 'fatal', 'erro', 'aviso', 'aviso', 'info', 'depuração'

Além disso, você pode substituir invocações individuais do decorador por parâmetros personalizados:

 class MyClass ():

    @ secure_logger ( log_level = 'DEBUG' , sensitive_keys = [ "password" , "apikey" , "crown_jewels" ], message = "*** -- TOP SECRET -- ***" , indent = 4 )
    def another_function ( self , password : str , apikey : str , crown_jewels : List ( dict )):
         pass 

Padrões de configuração

 SECURE_LOGGER_REDACTION_MESSAGE = "*** -- secure_logger() -- ***"
SECURE_LOGGER_INDENTATION = 4
SECURE_LOGGER_SENSITIVE_KEYS = [
    "password" ,
    "token" ,
    "client_id" ,
    "client_secret" ,
    "Authorization" ,
    "secret" ,
    "access_key_id" ,
    "secret_access_key" ,
    "access-key-id" ,
    "secret-access-key" ,
    "aws_access_key_id" ,
    "aws_secret_access_key" ,
    "aws-access-key-id" ,
    "aws-secret-access-key" ,
]
SECURE_LOGGER_LOG_LEVEL = 'DEBUG' 

Contribuindo

Os pedidos de tração são bem -vindos e incentivados!

• Este projeto usa um processo de CI/CD de solicitação de tração automatizado.
• Este projeto está em conformidade com a metodologia de 12 fatores.
• Este projeto usa versão semântica, que exige que as mensagens Git Commit sigam regras rigorosas (mas fáceis de aprender).

Contato: Lawrence McDaniel.