{"id":19412062,"url":"https://github.com/outbit/pivportal","last_synced_at":"2025-04-24T11:30:46.146Z","repository":{"id":54662528,"uuid":"68428643","full_name":"outbit/pivportal","owner":"outbit","description":"Secure Linux access using a PIV (HSPD-12), CAC, SmartCard, or x509 Client Certificate remotely without a physical card reader.","archived":false,"fork":false,"pushed_at":"2024-04-10T13:44:43.000Z","size":463,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-03T04:12:01.478Z","etag":null,"topics":["cac","hspd-12","hspd12","linux-client","pam-module","piv","pkcs11","security","smartcard"],"latest_commit_sha":null,"homepage":"https://outbit.com","language":"Python","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/outbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-17T03:01:52.000Z","updated_at":"2024-04-26T13:38:04.000Z","dependencies_parsed_at":"2024-11-10T12:26:05.215Z","dependency_job_id":null,"html_url":"https://github.com/outbit/pivportal","commit_stats":null,"previous_names":["starboarder2001/pivportal"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fpivportal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fpivportal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fpivportal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fpivportal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outbit","download_url":"https://codeload.github.com/outbit/pivportal/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250618070,"owners_count":21460018,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cac","hspd-12","hspd12","linux-client","pam-module","piv","pkcs11","security","smartcard"],"created_at":"2024-11-10T12:24:43.202Z","updated_at":"2025-04-24T11:30:45.789Z","avatar_url":"https://github.com/outbit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pivportal\n===========\n\nSecure Linux sudo access using a PIV (HSPD-12), CAC, SmartCard, or x509 Client Certificate.\n\n[![Build Status](https://travis-ci.org/outbit/pivportal.png?branch=master \"ansible-docs latest build\")](http://travis-ci.org/outbit/pivportal)\n[![PIP Version](https://img.shields.io/pypi/v/pivportal.svg \"ansible-docs PyPI version\")](https://pypi.python.org/pypi/pivportal)\n[![Coverage Status](https://coveralls.io/repos/outbit/pivportal/badge.svg?branch=develop\u0026service=github)](https://coveralls.io/github/outbit/pivportal?branch=develop)\n[![Gitter IM](https://badges.gitter.im/Join%20Chat.svg)](https://matrix.to/#/#pivportal:gitter.im)\n\n![alt tag](https://raw.githubusercontent.com/outbit/pivportal/images/pivportal_web.png)\n![alt tag](https://raw.githubusercontent.com/outbit/pivportal/images/pivportal_client.png)\n\nInstalling pivportal Server\n======\n\n```bash\n$ docker pull outbit/pivportal\n```\n\nConfiguring pivportal Server\n======\n\n```bash\ndocker run -d -p 80:80 -p 442:442 -p 443:443 outbit/pivportal\n```\n\nIn the running docker instance, **you are required to**:\n\n- Copy CA and intermediate certificates (in x509 PEM format) in /etc/ssl/private/pivportalCA.crt.\n- Edit /etc/pivportal-server.conf and add the Designated Names you authorize to use the application. The file includes examples.\n\nIn the running docker instance, **it is recommended to**:\n\n- Copy the CRL (certificate revokation list) to /etc/ssl/private/pivportal.crl and uncomment the line in /etc/apache2/sites-enabled/httpd-pivportal.conf.\n- Copy your valid SSL public certificate to /etc/ssl/private/pivportal.crt.\n- Copy your valid SSL private certificate to /etc/ssl/private/pivportal.key.\n\nConnect using a web browser to the pivportal server.\n\nPAM Configuration on Linux Client\n======\n\n- Build and Install pam_pivportal.so.\n- Copy /etc/ssl/private/pivportalClient.pem from the docker container to /etc/ssl/certs/pivportalClient.pem on each Linux Client.\n\nExample /etc/pam.d/sudo file:\n\n```bash\nauth required pam_pivportal.so\naccount include system-auth\npassword include system-auth\nsession optional pam_keyinit.so revoke\nsession required pam_limits.so\n```\n\nExample /etc/pivportal.conf:\n\nhosts - Hostname or IP Address of the server. Default is 127.0.0.1.\n\nport - TCP Port for pam_pivportal to authenticate to the server. Default is 442.\n\nclient_ssl_cert - Client SSL certificate used by the pam_pivportal module to authenticate to the pivportal server. Default is /etc/ssl/certs/pivportalClient.pem.\n\nssl_verify_host - SSL verify server certificate is valid. 0 = false, 1 = true. Default is false.\n\n```bash\n[server]\nhosts=192.16.0.1;192.168.0.2\nport=442\nclient_ssl_cert=/etc/ssl/certs/pivportalClient.pem\nssl_verify_host=0\n```\n\nLicense\n======\n\npivportal is released under the [MIT License](LICENSE.md).\n\n\nAuthor\n======\n\nDavid Whiteside (\u003cdavid@davidwhiteside.com\u003e)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutbit%2Fpivportal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutbit%2Fpivportal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutbit%2Fpivportal/lists"}