ldap_lookup 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957c311d5d68fcc94258c7f1263c2c17c4f9c2455f7043832fe5c3791ebd3cc8
-  data.tar.gz: e3029a5edf0799b9f1d5a13407639658f7360d9a1c8e4cfd663798f014008e06
+  metadata.gz: 393d3bdcafb4cadf5648c6916122ebfb7b0c6fefe79c5d50b6c6c57f6d6997cc
+  data.tar.gz: de8be14be88d2d4e3102971cf62d4a316cdc6a0aaa7e6268aee62659723e5ca2
 SHA512:
-  metadata.gz: 32f0da915876e614ca9374d59a3045e924905b7ff2f218a4b73133d92ca718dec5afdd0f91fbcdf23052b9cddde85c37f075d8311d6a91aac539dce3cf2bfc31
-  data.tar.gz: 8d788fd099caf5b0df62e6e7eac16303b08ec18ec2b4ec734a5d3e84d0b6a730bf1bfc4b93b8ee6ec5a3af3cfd6409a46a605a8fa2b350a1fe56987d1c50a62e
+  metadata.gz: 7dd298be615e445056d806602b27cb05e01a0783556fe09c32d1c5599ff877a18c286d1d2e845f1f5ec30c4b08745668ec5fd8f2717e4393cc7c45dd7e33254d
+  data.tar.gz: 6bb46112525a64c3c63fd1cb2d356e151ff48154515684040d5c1519464619681942f36a45ba275d0749abcd5b04afd81bc28ddb9a72d9c403eba5dc093d0970

data/README.md

@@ -9,22 +9,35 @@ This module is to be used for authenticated or anonymous lookup of user attribut
 
 Requirements:
 * Ruby at least 2.0.0
-* Gem 'net-ldap' ~> '0.17.0'
+* Gem 'net-ldap' ~> '0.18.0'
 > *The Net::LDAP (aka net-ldap) gem before 0.16.0 for Ruby has a Missing SSL Certificate Validation.*
 
 To try the module out:
 1. Clone the repo
-2. Edit the configurations by opening ldaptest.rb and set the *CONFIGURATION BLOCK* to your environment.
+2. Copy the env template and set credentials: `cp .env.example .env`
+3. Load the env vars into your shell (example):
+   ```bash
+   set -a
+   source .env
+   set +a
+   ```
+4. Edit the configurations by opening ldaptest.rb and set the *CONFIGURATION BLOCK* to your environment (it reads from the `.env` values you just loaded).
 <pre>
 LdapLookup.configuration do |config|
-      config.host = <em>< your host ></em> # "ldap.umich.edu"
-      config.port = <em>< your port ></em> # "389" (default) for STARTTLS, "636" for LDAPS
-      config.base = <em>< your LDAP base ></em> # "dc=umich,dc=edu"
-      config.username = <em>< your uniqname ></em> # Your UM uniqname (e.g., "rsmoke")
-      config.password = <em>< your password ></em> # Your UM password
-      config.encryption = :start_tls  # :start_tls (default, port 389) or :simple_tls (LDAPS, port 636)
-      config.dept_attribute = <em>< your dept attribute ></em> # "umichPostalAddressData"
-      config.group_attribute = <em>< your group email attribute ></em> # "umichGroupEmail"
+      config.host = ENV['LDAP_HOST'] || "ldap.umich.edu"
+      config.port = ENV['LDAP_PORT'] || "389"
+      config.base = ENV['LDAP_BASE'] || "dc=umich,dc=edu"
+      # Leave username/password unset for anonymous binds
+      config.username = ENV['LDAP_USERNAME']
+      config.password = ENV['LDAP_PASSWORD']
+      # Read encryption from ENV, default to start_tls
+      encryption_str = ENV['LDAP_ENCRYPTION'] || 'start_tls'
+      config.encryption = encryption_str.to_sym
+      config.dept_attribute = ENV['LDAP_DEPT_ATTRIBUTE'] || "umichPostalAddressData"
+      config.group_attribute = ENV['LDAP_GROUP_ATTRIBUTE'] || "umichGroupEmail"
+      # Enable LDAP debug logging in this test runner
+      debug_str = ENV['LDAP_DEBUG']
+      config.debug = debug_str ? debug_str.to_s.downcase == 'true' : true
 end
 </pre>
 
@@ -36,7 +49,7 @@ end
 
 The gem can also perform **anonymous binds** for LDAP servers that allow them. To use anonymous binds, leave `LDAP_USERNAME` and `LDAP_PASSWORD` unset.
 
-3. run the ldaptest.rb script
+5. run the ldaptest.rb script
 ```ruby
 ruby ./ldaptest.rb
 ```
@@ -79,21 +92,21 @@ LdapLookup.configuration do |config|
   config.host = ENV.fetch('LDAP_HOST', 'ldap.umich.edu')
   config.port = ENV.fetch('LDAP_PORT', '389')
   config.base = ENV.fetch('LDAP_BASE', 'dc=umich,dc=edu')
-  
+
   # Authentication (optional for anonymous binds)
   # Leave unset to use anonymous binds (if your LDAP server allows it)
   config.username = ENV['LDAP_USERNAME']
   config.password = ENV['LDAP_PASSWORD']
-  
+
   # If using a service account with custom bind DN, uncomment and set:
   # config.bind_dn = 'cn=service-account,ou=Service Accounts,dc=umich,dc=edu'
-  
+
   # Encryption - REQUIRED (defaults to STARTTLS)
   config.encryption = ENV.fetch('LDAP_ENCRYPTION', 'start_tls').to_sym
   # Use :simple_tls for LDAPS on port 636
   # TLS verification (defaults to true). Set LDAP_TLS_VERIFY=false only for local testing.
   # Optional custom CA bundle: set LDAP_CA_CERT=/path/to/ca-bundle.pem
-  
+
   # Optional: Attribute Configuration
   config.dept_attribute = ENV.fetch('LDAP_DEPT_ATTRIBUTE', 'umichPostalAddressData')
   config.group_attribute = ENV.fetch('LDAP_GROUP_ATTRIBUTE', 'umichGroupEmail')
@@ -118,19 +131,40 @@ end
 
 #### Step 4: Set Environment Variables
 
-**Never hardcode credentials in your code!** Use environment variables (Hatchbox, Heroku, etc.):
+**Never hardcode credentials in your code!** Use environment variables (Hatchbox, Heroku, etc.).
+
+**Development with `.env.example` (recommended):**
+1. Copy the template: `cp .env.example .env`
+2. Update the values in `.env` for your environment.
+3. Load the variables into your shell (example):
+   ```bash
+   set -a
+   source .env
+   set +a
+   ```
 
+**Typical `.env` values:**
 ```bash
-# In your .env file (for development)
 LDAP_USERNAME=your_service_account_uniqname
 LDAP_PASSWORD=your_service_account_password
+```
+
+**Optional settings (override defaults as needed):**
+```bash
+LDAP_HOST=ldap.umich.edu
+LDAP_PORT=389
+LDAP_BASE=dc=umich,dc=edu
+LDAP_ENCRYPTION=start_tls
+LDAP_TLS_VERIFY=true
+LDAP_CA_CERT=/path/to/ca-bundle.pem
+LDAP_DEPT_ATTRIBUTE=umichPostalAddressData
+LDAP_GROUP_ATTRIBUTE=umichGroupEmail
+```
 
-# Or export in your shell
+**Alternative: export in your shell**
+```bash
 export LDAP_USERNAME=your_service_account_uniqname
 export LDAP_PASSWORD=your_service_account_password
-
-# You can also set these (all can be changed without redeploying):
-# LDAP_HOST, LDAP_PORT, LDAP_BASE, LDAP_ENCRYPTION, LDAP_TLS_VERIFY, LDAP_CA_CERT
 ```
 
 **For Production:**

data/lib/ldap_lookup/version.rb

@@ -1,3 +1,3 @@
 module LdapLookup
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap_lookup
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Rick Smoke