{"id":22808970,"url":"https://github.com/ccuffs/auth-iduffs","last_synced_at":"2026-03-07T00:30:51.191Z","repository":{"id":49160492,"uuid":"217413430","full_name":"ccuffs/auth-iduffs","owner":"ccuffs","description":"Biblioteca para autenticação de usuários utilizando o idUFFS","archived":false,"fork":false,"pushed_at":"2022-01-28T19:27:33.000Z","size":99,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-23T22:20:27.349Z","etag":null,"topics":["academic","authentication","composer-package","computer-science","hacktoberfest","php","php7","uffs"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ccuffs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-24T23:36:44.000Z","updated_at":"2023-06-04T00:18:43.000Z","dependencies_parsed_at":"2022-07-30T14:48:14.213Z","dependency_job_id":null,"html_url":"https://github.com/ccuffs/auth-iduffs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ccuffs/auth-iduffs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Fauth-iduffs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Fauth-iduffs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Fauth-iduffs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Fauth-iduffs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ccuffs","download_url":"https://codeload.github.com/ccuffs/auth-iduffs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccuffs%2Fauth-iduffs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30204154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"ssl_error","status_checked_at":"2026-03-06T18:57:34.882Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["academic","authentication","composer-package","computer-science","hacktoberfest","php","php7","uffs"],"created_at":"2024-12-12T11:13:02.688Z","updated_at":"2026-03-07T00:30:51.164Z","avatar_url":"https://github.com/ccuffs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\".github/logo.png\" title=\"Logo do projeto\"\u003e\u003cbr /\u003e\n    \u003cimg src=\"https://img.shields.io/maintenance/yes/2022?style=for-the-badge\" title=\"Status do projeto\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/workflow/status/ccuffs/auth-iduffs/CI?label=Build\u0026logo=github\u0026logoColor=white\u0026style=for-the-badge\" title=\"Build status\"\u003e\n\u003c/p\u003e\n\n# auth-iduffs\n\nUm pacote PHP para autenticação de usuários através do [idUFFS](https://id.uffs.edu.br) da [Universidade Federal da Fronteira Sul](https://www.uffs.edu.br). Além de prover autenticação, ele oferece informações sobre o usuário autenticado, como nome completo, CPF, entre outros.\n\n## ✨Features\n\n* Autenticação com o endpoint [id.uffs.edu.br](https://id.uffs.edu.br) via HTTPS;\n* Não necessita de tokens ou autorizações de API;\n* Obtem informações sobre o usuário (nome, CPF, etc);\n\n## 🚀 Utilização\n\n### 1. Adicione o pacote ao seu projeto\n\nNa pasta raiz do seu projeto PHP, rode:\n\n```\ncomposer require ccuffs/auth-iduffs\n```\n\nTodas as dependências serão instaladas.\n\n### 2. Autenticando usuários\n\nPara autenticar um usuário, você utilizará a classe `AuthIdUFFS` informando os valores `user` e `password`, que são o idUFFS e senha do usuário, respecitivamente.\n\nAs informações são passadas ao método `login()` através de um array associativo:\n\n```php\n$auth = new CCUFFS\\Auth\\AuthIdUFFS();\n\n$info = $auth-\u003elogin([\n    'user'     =\u003e 'meuIdUFFS',\n    'password' =\u003e 'minhaSenha'\n]);\n```\n\nSe as credenciais informadas forem válidas, o método `login()` retorna um objeto com as seguintes propriedades:\n\n```php\nobject(stdClass)\n  public 'username' =\u003e string\n  public 'uid' =\u003e string\n  public 'email' =\u003e string\n  public 'pessoa_id' =\u003e string\n  public 'name' =\u003e string\n  public 'cpf' =\u003e string\n  public 'location' =\u003e string\n  public 'token_id' =\u003e string \n  public 'authenticated' =\u003e boolean\n``` \n\nSe as credenciais não forem válidas (usuário ou senha incorretos), o método `login()` retorna `null`.\n\n## 👩‍💻 Desenvolvimento\n\nSe você pretende criar features novas, corrigir bugs ou afins, siga o passo a passo abaixo.\n\nClone o repositório:\n\n```\ngit clone https://github.com/ccuffs/auth-iduffs \u0026\u0026 cd auth-iduffs\n```\n\nInstale as dependências:\n\n```\ngit clone https://github.com/ccuffs/auth-iduffs \u0026\u0026 cd auth-iduffs\n```\n\nImplemente o que for necessário e rode os testes:\n\n```\n./vendor/bin/pest\n```\n\nUm dos testes (de autenticação de usuário valido) necessita de um idUFFS e senha válidos. Você pode informar esses valores através das variáveis de ambiente `AUTH_IDUFFS_TEST_USERNAME` e `AUTH_IDUFFS_TEST_PASSWORD`, respectivamente.\n\nSe essas variáveis de ambiente não forem informadas, somente um dos testes deve falhar. Os demais devem passar.\n\n## 🤝 Contribua\n\nSua ajuda é muito bem-vinda, independente da forma! Confira o arquivo [CONTRIBUTING.md](CONTRIBUTING.md) para conhecer todas as formas de contribuir com o projeto. Por exemplo, [sugerir uma nova funcionalidade](https://github.com/ccuffs/auth-iduffs/issues/new?assignees=\u0026labels=\u0026template=feature_request.md\u0026title=), [reportar um problema/bug](https://github.com/ccuffs/auth-iduffs/issues/new?assignees=\u0026labels=bug\u0026template=bug_report.md\u0026title=), [enviar um pull request](https://github.com/ccuffs/hacktoberfest/blob/master/docs/tutorial-pull-request.md), ou simplemente utilizar o projeto e comentar sua experiência.\n\n\n## 🎫 Licença\n\nEsse projeto é licenciado nos termos da licença open-source [MIT](https://choosealicense.com/licenses/mit) e está disponível de graça.\n\n## 🧬 Changelog\n\nVeja todas as alterações desse projeto no arquivo [CHANGELOG.md](CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccuffs%2Fauth-iduffs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccuffs%2Fauth-iduffs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccuffs%2Fauth-iduffs/lists"}