Added documentation for Ldap

docker/backend/src/backend/ldap.cr

@@ -3,27 +3,35 @@ require "socket"
 require "ldap_escape"
 
 module Backend
+  # Provides LDAP utility functions
   module Ldap
     extend self
 
+    # Creates a new LDAP connection
     def create_client : LDAP::Client
       LDAP::Client.new(TCPSocket.new(Backend.config.ldap.host, Backend.config.ldap.port))
     end
 
+    # Constructs a CN DN from a username
     def cn(username : String) : String
       "cn=#{LdapEscape.dn(username)},#{Backend.config.ldap.user_dn}"
     end
 
+    # Constructs a UID DN from a username
     def uid(uid : String) : String
       "uid=#{LdapEscape.dn(uid)},#{Backend.config.ldap.base_user_dn}"
     end
 
+    # Queries the LDAP server for a user
+    #
+    # NOTE: Returns a hash of the user's attributes
     def user(dn : String) : Array(Hash(String, Array(String)))
       create_client
         .authenticate(Backend.config.ldap.bind_dn, Backend.config.ldap.bind_password)
         .search(base: dn)
     end
 
+    # Checks if credentials are valid
     def authenticate?(dn : String, password : String) : Bool
       !!create_client.authenticate(dn, password)
     rescue LDAP::Client::AuthError