Documentação de como sera feita a autenticação e autorizacao dos usuarios

[thiagonobrega]

Documentar com diagramas de sequencia como sera feita a autenticacao e identificação dos usuários para a chamada dos metodos protegidos.

Os documentos devem ser salvos na pasta docs/ e escritos em ingles.

@samuelfsd e @fransilva0

[fransilva0]

@thiagonobrega a seguir segue um rascunho dos diagramas para você verificar e apontar melhorarias.

Diagrama de autenticação de usuários:

sequenceDiagram
    User->>+Hyperdrive: send authentication data
    Hyperdrive->>+JWT: searchUser(email, password)
    JWT->>+database: authenticate (email, password)
    database-->>+ JWT: user exists | boolean
    JWT->>+JWT: generate access token
    JWT-->>+Hyperdrive: send the access token
    Hyperdrive-->>+User: send the access token

Loading

Diagrama de acesso a métodos protegidos:

 sequenceDiagram
    User->>+Hyperdrive: calls protected method
    Hyperdrive->>+JWT: check access token
    JWT-->>+Hyperdrive: valid token | boolean
    Hyperdrive->>+Hyperdrive: Execute Protected Method
    Hyperdrive-->>+User: send execution result

Loading

Eu e o @samuelfsd aguardamos seus apontamentos para realizar melhorias em ambos os diagramas.

[thiagonobrega]

Pontos de melhoria:

1. Como seria a menssagem de autenticação?
   exemplo
   ˋˋˋjson
   {
   user : xpto
   password : passwd
   }
   ˋˋˋ

2. Como a seria a autenticacao?
   Descrever as classes ou servicos

3. Quais as alterações nas msgs originais teremos?

[fransilva0]

@thiagonobrega

Atualizando o diagrama 1:

sequenceDiagram
    User->>+Hyperdrive: login(email, password)
    Hyperdrive->>+JWT: send user email and password for authentication
    JWT->>+database: authenticate (email, password)
    database-->>+ JWT: user exists | boolean
    JWT->>+JWT: generate access token
    JWT-->>+Hyperdrive: save user access token
    Hyperdrive-->>+User: send the access token

Loading

OBS: de forma mais detalhada o diagrama de sequência mostra, agora, que o usuário irá chamar
um método de login cujo a chamada seria:

curl -X POST http://$API_HOST:$API_PORT/user/login -H 'Content-Type: application/json' -d '{"email":"valid_email", "password" : "valid_password" }'

esse método deve receber como parametros, em JSON, o email e senha do usuário para verificar
se ele de fato é um usuário existente na base de dados e com isso a classe JWT responsável
pela autenticação, possa gerar o token de usuário, além de armazenar o token no hyperdrive que
envia ao usuário, por meio da mensagem de resposta, para ser utilizado para acesso aos métodos protegidos.

OBS2: Precisaríamos modificar as mensagens dos métodos que já foram feitos (a exemplo, add_url)
de forma que, além dos dados enviados no JSON das chamadas, ele passe também outro dado que seria o seu token. No caso o hyperdrive, antes de rodar o método chamado, vai perguntar ao JWT se
o token enviado realmente pertence ao usuário logado e se a resposta for verdade o hyperdrive
irá chamar o método que o usuário deseja sem barramentos. Caso for falso o resultado, o hyperdrive
precisa alertar ao usuário de um erro no token e barrar a chamada do método protegido.

Isso ainda precisa ser acrescentado a documentação do Hyperdrive. Quanto ao JWT esbarramos em uma dúvida e gostaríamos de uma opinião sua: de acordo com pesquisas do Samuel, guardar o token no banco não é a melhor das práticas, quando o usuario fizer o login ele vai receber um acess token, e esse token vai permitir ele acessar os endpoints. a gente tem algumas opções guardar ele na memoria por um tempo ou usar cache. O que você acredita ser melhor para a regra de negócio do projeto?

[fransilva0]

Se estiver faltando mais alguma coisa a ser esclarecida ou melhorada fique à vontade para apontar

[thiagonobrega]

@fransilva0 comprendi o processo de autenticação.

Antes de iniciar a implementacao você pode alterar a documentacao das menssagens ( https://github.com/dark-pid/hyperdrive/tree/develop/docs ) colocando o parametro (token jwt) nas rotas?

Você pode documentar a nova rota de autenticacao do usuário ( /user/login ) como as demais ?

ps : Todas as rotas existentes (com a execeção do get) serao protegidas.
pps: criar uma branch e assim que terminar pede PR.

[fransilva0]

@thiagonobrega PR aberta, você pode dar uma conferida no README da pasta de documentação, adicionei os diagramas na pasta Diagrams também. Quanto a dúvida do JWT ainda aguardando uma resposta.

[thiagonobrega]

@fransilva0 Vi a PR e a aceita contudo ainda vou te pedir alguns ajustes.

1. Vi que nos ja tinhamos um variavel para a autenticacao, vamos utilizar auth_token no lugar de access ok?

2. Ourtro ponto vi que voce duplicaou a tabela de metodos/rotas me faz um favor? Transcreve esse memtodo para a tabela orginal.
   

Lembrando que tabela orignial fica la no topo

3. Renomear o metodo. Acho que voce copiou e colou o a estrutura. Então coloca o nome mais significativo como o iluystrato na imagem.

Att, Thiago

[thiagonobrega]

@thiagonobrega PR aberta, você pode dar uma conferida no README da pasta de documentação, adicionei os diagramas na pasta Diagrams também. Quanto a dúvida do JWT ainda aguardando uma resposta.

@fransilva0 perdão qual foi a pergunta? acho que passei batido.

[fransilva0]

@thiagonobrega pergunta: de acordo com pesquisas do Samuel, guardar o token no banco não é a melhor das práticas, quando o usuario fizer o login ele vai receber um acess token, e esse token vai permitir ele acessar os endpoints. a gente tem algumas opções guardar ele na memoria por um tempo ou usar cache. O que você acredita ser melhor para a regra de negócio do projeto?

OBS: vou subir uma nova PR com esses ajustes o mais breve possível