{"id":16333643,"url":"https://github.com/minijackson/paddle","last_synced_at":"2025-06-12T03:08:33.025Z","repository":{"id":15303627,"uuid":"67437784","full_name":"minijackson/paddle","owner":"minijackson","description":"A library simplifying LDAP usage in Elixir projects","archived":false,"fork":false,"pushed_at":"2023-04-11T00:00:51.000Z","size":129,"stargazers_count":55,"open_issues_count":22,"forks_count":14,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-22T23:47:31.495Z","etag":null,"topics":["elixir","ldap","ldap-authentication","ldap-library"],"latest_commit_sha":null,"homepage":"","language":"Elixir","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/minijackson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-05T17:02:54.000Z","updated_at":"2025-03-30T07:05:05.000Z","dependencies_parsed_at":"2024-10-10T23:46:21.334Z","dependency_job_id":null,"html_url":"https://github.com/minijackson/paddle","commit_stats":{"total_commits":70,"total_committers":8,"mean_commits":8.75,"dds":0.1428571428571429,"last_synced_commit":"01d5f8e8ce3a16655e3d59af99030944cdc0b11b"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/minijackson/paddle","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minijackson%2Fpaddle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minijackson%2Fpaddle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minijackson%2Fpaddle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minijackson%2Fpaddle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minijackson","download_url":"https://codeload.github.com/minijackson/paddle/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minijackson%2Fpaddle/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259387619,"owners_count":22849747,"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":["elixir","ldap","ldap-authentication","ldap-library"],"created_at":"2024-10-10T23:36:09.764Z","updated_at":"2025-06-12T03:08:33.008Z","avatar_url":"https://github.com/minijackson.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Paddle\n\n[![hex.pm version](https://img.shields.io/hexpm/v/paddle.svg)](https://hex.pm/packages/paddle)\n[![Build Status](https://travis-ci.org/minijackson/paddle.svg?branch=master)](https://travis-ci.org/minijackson/paddle)\n[![Inline docs](http://inch-ci.org/github/minijackson/paddle.svg)](http://inch-ci.org/github/minijackson/paddle)\n\nA library simplifying LDAP usage in Elixir projects.\n\n[Documentation](https://hexdocs.pm/paddle/Paddle.html)\n\n## Why another LDAP library?\n\nIf you want to communicate with an LDAP server in Elixir, you probably know\nthat there are other libraries out there. However, I didn't find one that\nsuited me:\n\n- The [`:eldap`](http://erlang.org/doc/man/eldap.html) library is great, but\n  very low-level, with no high-level features.\n\n- [EctoLdap](https://github.com/jeffweiss/ecto_ldap) is very interesting, but I\n  needed the add / modify / delete operations (in fact, I even wanted to do an\n  Ecto adapter at first).\n\n- [Exldap](https://github.com/jmerriweather/exldap) and\n  [LDAPEx](https://github.com/OvermindDL1/ldap_ex) are both a translation of\n  the LDAP `:eldap` in Elixir, which is nice, but are still missing some\n  higher-level features.\n\n## Usage\n\nOnce installed and configured, it allows you to quickly authenticate users:\n\n```elixir\niex\u003e Paddle.authenticate(\"myUser\", \"password\")\n:ok\n```\n\nGet meaningful information using [Paddle.Class](https://hexdocs.pm/paddle/Paddle.Class.html) structs:\n\n```elixir\niex\u003e Paddle.get %MyApp.PosixAccount{uid: \"myUser\"}\n{:ok,\n [%MyApp.PosixAccount{cn: [\"My User\"], description: nil,\n   gecos: [\"My User,,,,\"], gidNumber: [\"120\"],\n   homeDirectory: [\"/home/myuser\"], host: nil, l: nil,\n   loginShell: [\"/bin/bash\"], o: nil, ou: nil, seeAlso: nil, uid: [\"myUser\"],\n   uidNumber: [\"500\"],\n   userPassword: [\"{SSHA}AIzygLSXlArhAMzddUriXQxf7UlkqopP\"]}]}\n```\n\nOr get information just about anything:\n\n```elixir\niex\u003e Paddle.get base: [ou: \"People\"], filter: [objectClass: \"organizationalUnit\"]\n{:ok,\n [%{\"dn\" =\u003e \"ou=People,dc=test,dc=com\",\n    \"objectClass\" =\u003e [\"top\", \"organizationalUnit\"], \"ou\" =\u003e [\"People\"]}]}\n```\n\nAdd, delete, modify operations are supported. If you want to know more, just\ngo to [the documentation](https://hexdocs.pm/paddle/Paddle.html).\n\n## Installation\n\nThe package can be installed as:\n\n1. Add `paddle` to your list of dependencies in `mix.exs`:\n\n    ```elixir\n    def deps do\n      [{:paddle, \"~\u003e 0.1.0\"}]\n    end\n    ```\n\n2. Ensure `paddle` is started before your application:\n\n    ```elixir\n    def application do\n      [applications: [:paddle]]\n    end\n    ```\n\n3. Add your configuration in your config files:\n\n    ```elixir\n    config :paddle, Paddle,\n      host: \"ldap.my-organisation.org\",\n      base: \"dc=myorganisation,dc=org\",\n      ssl: true,\n      port: 636\n    ```\n\n    For more configurations, see the [`Paddle` module docmumentation](https://hexdocs.pm/paddle/Paddle.html#module-configuration).\n\n## Testing\n\nIf you want to test this application, you can use the linux commands\ndescribed in the [.travis.yml](.travis.yml) file in the\n`before_script` block to start a local test LDAP server.\n\nKeep in mind that you may need to change the\n[.travis/ldap/slapd.conf](.travis/ldap/slapd.conf) for your system by changing\nsome configuration paths.\n\nIf you want to add some more data to the test server, please feel free\nto issue a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminijackson%2Fpaddle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminijackson%2Fpaddle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminijackson%2Fpaddle/lists"}