Download the PHP package salexcarvalho/govbr-auth without Composer

On this page you can find all versions of the php package salexcarvalho/govbr-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of salexcarvalho/govbr-auth

Informations about the package govbr-auth

GovBR Auth

Latest Version on Packagist PHP Version Laravel Tests

Pacote Laravel para autenticação com o Gov.br via protocolo OpenID Connect (OIDC). Integre o login unificado do governo federal brasileiro em qualquer aplicação Laravel em minutos.

Sumário

📦 Requisitos

Dependência Versão mínima
PHP 7.4
Laravel 8.x, 9.x, 10.x, 11.x ou 12.x
Extensão OpenSSL qualquer
GuzzleHTTP ^7.0
firebase/php-jwt ^6.0

🚀 Instalação

Publique o arquivo de configuração:

🔧 Configuração

Defina as variáveis no seu .env:

Staging (homologação): substitua sso.acesso.gov.br por sso.staging.acesso.gov.br.

Para obter credenciais, acesse o Portal do Desenvolvedor Gov.br.

🚧 Rotas disponíveis

O pacote registra automaticamente as seguintes rotas:

Método URI Nome Descrição
GET /auth/govbr/redirect govbr.login Redireciona o usuário para o portal Gov.br
GET /auth/govbr/callback govbr.callback Recebe o código de autorização e autentica
POST /auth/govbr/logout govbr.logout Encerra a sessão Gov.br

Inicie o login com:

🛡️ Protegendo rotas

Use o middleware govbr.auth para restringir acesso a usuários autenticados via Gov.br:

👤 Modelo de usuário personalizado

Por padrão, o pacote usa o modelo definido em auth.providers.users.model. Para sobrescrever, defina em config/govbr.php (ou via .env):

O modelo deve ter uma coluna govbr_sub (chave do usuário no Gov.br) e aceitar name e email como atributos preenchíveis:

⚠️ Tratamento de erros

O pacote lança GovBrAuthException em situações de erro. Registre um handler no seu app/Exceptions/Handler.php para apresentar uma resposta amigável ao usuário:

Situações que disparam a exceção:

Situação Mensagem
Recusa de autorização pelo usuário Erro de autorização Gov.br: access_denied
Parâmetro state inválido (CSRF) Parâmetro state inválido.
Código de autorização ausente Código de autorização não recebido.
Falha de rede no endpoint de token Falha ao comunicar com o endpoint de token do Gov.br
id_token ausente na resposta Resposta do token inválida: id_token ausente.
JWT inválido ou expirado Falha na validação do id_token

🔄 Fluxo de autenticação

🧪 Testes

Para gerar relatório de cobertura:

🤝 Contribuição

Contribuições são bem-vindas! Por favor, leia o CONTRIBUTING.md antes de abrir um Pull Request.

  1. Faça um fork do repositório
  2. Crie sua branch: git checkout -b feature/minha-feature
  3. Commit: git commit -m 'feat: adiciona minha feature'
  4. Push: git push origin feature/minha-feature
  5. Abra um Pull Request

📋 Changelog

Veja o CHANGELOG.md para o histórico de mudanças.

📝 Licença

MIT — veja o arquivo LICENSE para mais detalhes.

All versions of govbr-auth with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
illuminate/support Version ^8.0|^9.0|^10.0|^11.0|^12.0
guzzlehttp/guzzle Version ^7.0
firebase/php-jwt Version ^6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package salexcarvalho/govbr-auth contains the following files

Loading the files please wait ...