tronnet/ProxmoxAAS-LDAP
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity
LDAP intermediate API for ProxmoxAAS
43 Commits 2 Branches 7 Tags 101 KiB
Go 98.4%
Makefile 1.6%
e18737c043
Go to file
Arthur Lu e18737c043 cleanup gitignore
2024-10-23 22:46:43 +00:00
app add starttls support, 2024-10-18 04:38:26 +00:00
configs add starttls support, 2024-10-18 04:38:26 +00:00
init add Makefile, move systemd service file to init folder 2024-06-20 03:03:11 +00:00
scripts fix make PHONY targets 2024-10-23 18:58:06 +00:00
test add unit tests for various utility functions, 2024-10-19 04:16:17 +00:00
.gitignore cleanup gitignore 2024-10-23 22:46:43 +00:00
go.mod update go.mod 2024-10-21 19:56:01 +00:00
Makefile fix make PHONY targets 2024-10-23 18:58:06 +00:00
proxmoxaas-ldap.go rewrite api in go/gin 2024-06-18 21:23:22 +00:00
README.md add unit tests for various utility functions, 2024-10-19 04:16:17 +00:00

README.md

ProxmoxAAS LDAP - Simple REST API for LDAP

ProxmoxAAS LDAP provides a simple API for managing users and groups in a simplified LDAP server. Expected LDAP configuration can be initialized using open-ldap-setup.

Installation

Prerequisites

  • Initialized LDAP server with the following configuration
    • Structure
      • Users: ou=people,...
        • objectType: inetOrgPerson
        • At least 1 user which is a member of admin group
      • Groups: ou=groups,...
        • objectType: groupOfNames
        • At least 1 admin group
    • Permissions:
      • Admin group should have write access
      • Users should have write access to own attributes (cn, sn, userPassword)
      • Enable anonymous binding
    • Load MemberOf Policy:
      • olcMemberOfDangling: ignore
      • olcMemberOfRefInt: TRUE
      • olcMemberOfGroupOC: groupOfNames
      • olcMemberOfMemberAD: member
      • olcMemberOfMemberOfAD: memberOf
    • Password Policy and TLS are recommended but not required

Installation

  1. Download proxmoxaas-ldap binary and template.config.json file from releases
  2. Rename template.config.json to config.json and modify:
    • ldapURL: url to the ldap server ie. ldap://ldap.domain.net
    • baseDN: base DN ie. dc=domain,dc=net
    • sessionSecretKey: random value used to randomize cookie values, replace with any sufficiently large random string
  3. Run the binary

Building and Testing from Source

Building requires the go toolchain. Testing requires the go toolchain, make, and apt. Currently only supports Debian.

Building from Source

  1. Clone the repository
  2. Run go get to get requirements
  3. Run make to build the binary

Testing Source

  1. Clone the repository
  2. Run go get to get requirements
  3. Run make dev-init to install test requirements including openldap (slapd), ldap-utils, debconf-utils
  4. Run make tests to run all tests