GNU bug report logs - #16322
24.3; [PATCH] Streamline EUDC LDAP configuration

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 16322 in the body.
You can then email your comments to 16322 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3; [PATCH] Streamline EUDC LDAP configuration
Date: Wed, 01 Jan 2014 20:51:17 -0500

Hi,

I've published a set of patches to modernize EUDC LDAP configuration
[1].  Here is a summary of the changes:

- Replace ~/.eudc-options with Customize for the server hotlist

- Add support for ldapsearch's -H option, to allow specifying ldaps://
  host URIs for LDAP-over-SSL

- Implicitly append the LDAP wildcard character to the last attribute
  value of a query

- Improve expansion defaults (e.g., don't query on surname, by default
  expand to a format that includes first name, surname and email
  address)

- Improve password handling:

  - Add password-cache support for interactive prompting

  - Pass the password to ldapsearch through a pipe rather than on the
    command line

- Other minor compatibility and UI fixes

- Expand EUDC LDAP Info documentation, providing LDAP-over-SSL
  configuration examples

Thomas

1. https://code.launchpad.net/~fitzsim/emacs/streamline-eudc-configuration

In GNU Emacs 24.3.1 (x86_64-unknown-linux-gnu)
 of 2014-01-01 on fitzsim-lnx
Bzr revision: 111339 fitzsim <at> fitzsim.org-20140101224646-zf3e9atsnv3naf4z
System Description:	Red Hat Enterprise Linux Workstation release 6.4 (Santiago)

Configured using:
 `configure '--prefix=/local/program/streamline-eudc-configuration'
 '--with-x-toolkit=no''

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Major mode: Message

Minor modes in effect:
  mml-mode: t
  tooltip-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  auto-fill-function: message-do-auto-fill
  transient-mark-mode: t
  abbrev-mode: t

Recent input:
RET TAB TAB SPC M i l TAB RET C-x k RET C-g ESC x e 
b DEL m a c TAB b u TAB DEL DEL r e p o TAB DEL DEL 
DEL DEL DEL DEL DEL DEL DEL DEL r e p o TAB TAB TAB 
TAB t DEL r TAB RET

Recent messages:
Creating customization setup...done
To install your edits, invoke [State] and choose the Set operation
Change the state of this item.
byte-code: Incorrect LDAP password or bind distinguished name (binddn)
Parsing results... done
Parsing results... done
Parsing results... done
Making completion list...
Quit
Making completion list...

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug sendmail help-fns conf-mode help-mode
eudcb-ldap ldap password-cache eudc eudc-vars gnus-util edmacro kmacro
message format-spec rfc822 mml mml-sec mm-decode mm-bodies mm-encode
mail-parse rfc2231 rfc2047 rfc2045 ietf-drums mm-util mail-prsvr
mailabbrev mail-utils gmm-utils mailheader cus-edit cus-start cus-load
wid-edit ispell jka-compr info easymenu time-date tooltip ediff-hook
vc-hooks lisp-float-type mwheel x-win x-dnd tool-bar dnd fontset image
regexp-opt fringe tabulated-list newcomment lisp-mode register page
menu-bar rfn-eshadow timer select scroll-bar mouse jit-lock font-lock
syntax facemenu font-core frame cham georgian utf-8-lang misc-lang
vietnamese tibetan thai tai-viet lao korean japanese hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
case-table epa-hook jka-cmpr-hook help simple abbrev minibuffer loaddefs
button faces cus-face macroexp files text-properties overlay sha1 md5
base64 format env code-pages mule custom widget hashtable-print-readable
backquote make-network-process dbusbind dynamic-setting
system-font-setting font-render-setting x multi-tty emacs)

Message #8 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: help-debbugs <at> gnu.org (GNU bug Tracking System)
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Thu, 13 Nov 2014 03:50:46 -0500

Hi,

Now that the Emacs git repository is live, I've updated this patch set:

https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration

I rebased onto 24.4, did a clean build and confirmed the functionality
works in an emacs -Q session with minimal configuration.

I also use this patch set daily to interface with my company's LDAP
server; it greatly simplifies the configuration steps (i.e., workarounds
for bad eudc/ldap defaults [1]) that are otherwise required to get LDAP
email address completion working.

I'm hoping an Emacs maintainer can review these patches at some point.

Thanks,
Thomas

1. http://www.emacswiki.org/emacs/EUDC

Message #11 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Thu, 13 Nov 2014 16:49:22 +0200

> From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
> Date: Thu, 13 Nov 2014 03:50:46 -0500
> 
> Now that the Emacs git repository is live, I've updated this patch set:
> 
> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration

Thanks.  But this is not a patchset, it's a cloned repository with
changes, isn't it?  Can you send just the patches?

> I rebased onto 24.4, did a clean build and confirmed the functionality
> works in an emacs -Q session with minimal configuration.

If this is accepted, it will not be for the emacs-24 branch, so please
generate the changes relative to the master branch.

Message #14 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Thu, 13 Nov 2014 12:11:59 -0500

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
>> Date: Thu, 13 Nov 2014 03:50:46 -0500
>> 
>> Now that the Emacs git repository is live, I've updated this patch set:
>> 
>> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration
>
> Thanks.  But this is not a patchset, it's a cloned repository with
> changes, isn't it?  Can you send just the patches?

Sure.  Just for reference, the new branch based on master is:

https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration-2

>> I rebased onto 24.4, did a clean build and confirmed the functionality
>> works in an emacs -Q session with minimal configuration.
>
> If this is accepted, it will not be for the emacs-24 branch, so please
> generate the changes relative to the master branch.

I rebased and retested on master.  Attached is the patchset generated by
"git format-patch".

Thomas

[0001-Change-eudc-server-hotlist-from-a-defvar-to-a-defcus.patch (text/x-patch, attachment)]

[0002-Support-new-style-LDAP-URIs-in-ldap-search-internal.patch (text/x-patch, attachment)]

[0003-Improve-eudc-inline-query-format-s-default-value.patch (text/x-patch, attachment)]

[0004-Improve-eudc-inline-expansion-format-s-default-value.patch (text/x-patch, attachment)]

[0005-Ignore-text-properties-in-eudc-expand-inline.patch (text/x-patch, attachment)]

[0006-Change-eudc-expansion-overwrites-query-default-to-ni.patch (text/x-patch, attachment)]

[0007-Add-password-cache-support-to-ldap.el.patch (text/x-patch, attachment)]

[0008-ldap-search-internal-Send-password-to-ldapsearch-thr.patch (text/x-patch, attachment)]

[0009-Downcase-field-names-in-LDAP-results.patch (text/x-patch, attachment)]

[0010-Append-LDAP-wildcard-character-to-end-of-search-stri.patch (text/x-patch, attachment)]

[0011-Do-not-ask-the-user-for-an-LDAP-base-if-a-default-ha.patch (text/x-patch, attachment)]

[0012-Restore-former-eudc-expand-inline-settings-after-a-n.patch (text/x-patch, attachment)]

[0013-Handle-nil-password-cache-in-ldap-password-read.patch (text/x-patch, attachment)]

[0014-ldap-password-read-Validate-password-before-caching-.patch (text/x-patch, attachment)]

[0015-Update-LDAP-configuration-section-of-EUDC-manual.patch (text/x-patch, attachment)]

[0016-Mention-binddn-in-LDAP-credentials-error-message.patch (text/x-patch, attachment)]

Message #17 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Thu, 13 Nov 2014 22:16:07 +0200

> From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
> Cc: 16322 <at> debbugs.gnu.org
> Date: Thu, 13 Nov 2014 12:11:59 -0500
> 
> * eudc.texi (LDAP Configuration): Rename from LDAP Requirements
> and provide configuration examples.

A few comments about this part:

> +LDAP support is added by means of @file{ldap.el}, which is part of
> +Emacs.  @file{ldap.el} needs an external command line utility named
> +@file{ldapsearch}, available as part of OpenLDAP

Command names are better given the @command markup (here and elsewhere
in the patch).

> +@subsection Emacs-only Configuration

Please don't use sectioning commands without a corresponding @node.
Having subsections that aren't nodes makes those subsections harder to
find.

> +Specifying the function @code{ldap-password-read} for @code{passwd}
> +will cause Emacs to prompt interactively for the password.  The
> +password will then be validated and cached, unless
> +@code{password-cache} is nil.  You can customize
> +@code{password-cache-expiry} to control the duration for which the
> +password is cached.  If you want to clear the cache, call
> +@code{password-reset}.

Each variable or function you describe should have a corresponding
@findex or @vindex entry right before the description.

> +To authenticate, the @dfn{bind distinguished name (binddn)} is

When you introduce a new term using @dfn, please provide a @cindex
entry for that term.

> +@example
> +machine ldaps://directory.example.com binddn example\emacsuser password s3cr3t
> +@end example

This line is too long, and since lines in @example are never broken by
the typesetter, it will overflow the right margin.  Break it into 2 or
more lines, and indicate in the text that this is one long line, to
avoid confusion.

> +@example
> +binddn example\emacsuser password s3cr3t
> +@end example
> +
> +and the @file{.emacs} expressions become:

You need @noindent before the last line, otherwise it will be
indented, as it starts a new paragraph.

> +@lisp
> +(eval-after-load "message"
> +  '(define-key message-mode-map (kbd "TAB") 'eudc-expand-inline))
> +(customize-set-variable 'eudc-server-hotlist '(("" . bbdb) ("" . ldap)))
> +(customize-set-variable 'ldap-host-parameters-alist '(("" auth-source t)))
> +@end lisp

I think these lines are also too long, consider breaking them.

Thanks.

Message #20 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Sat, 15 Nov 2014 14:58:59 -0500

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
>> Cc: 16322 <at> debbugs.gnu.org
>> Date: Thu, 13 Nov 2014 12:11:59 -0500
>> 
>> * eudc.texi (LDAP Configuration): Rename from LDAP Requirements
>> and provide configuration examples.
>
> A few comments about this part:

[...]

New branch at:

https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration-3

Attached are the patches that address your comments, and make the new
@cindex concepts available in the index.  I wanted to keep the authinfo
configuration on one line so I shortened the example hostname.

Thanks,
Thomas

[0001-Update-LDAP-configuration-section-of-EUDC-manual.patch (text/x-patch, attachment)]

[0002-Combine-eudc.texi-indices.patch (text/x-patch, attachment)]

Message #23 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: 16322 <at> debbugs.gnu.org
Subject: bug#16322: 24.4;
 [PATCH] Streamline EUDC LDAP configuration (was: bug#16322:
 Acknowledgement (24.3; [PATCH] Streamline EUDC LDAP configuration))
Date: Sat, 20 Dec 2014 16:55:23 -0500

Thomas Fitzsimmons <fitzsim <at> fitzsim.org> writes:

> Now that the Emacs git repository is live, I've updated this patch set:
>
> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration
>
> I rebased onto 24.4, did a clean build and confirmed the functionality
> works in an emacs -Q session with minimal configuration.

Ping.  Can an Emacs maintainer review the code portions of these
patches?

Thanks,
Thomas

Message #26 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration
Date: Mon, 19 Jan 2015 20:44:07 -0500

Thomas Fitzsimmons <fitzsim <at> fitzsim.org> writes:

> Thomas Fitzsimmons <fitzsim <at> fitzsim.org> writes:
>
>> Now that the Emacs git repository is live, I've updated this patch set:
>>
>> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration
>>
>> I rebased onto 24.4, did a clean build and confirmed the functionality
>> works in an emacs -Q session with minimal configuration.
>
> Ping.  Can an Emacs maintainer review the code portions of these
> patches?

Are these patches OK to go in?

Thomas

Message #29 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration
Date: Tue, 20 Jan 2015 11:35:16 -0500

> Are these patches OK to go in?

I must admit that my Git foo is still too limited to know/remember how
to get the "diff between fitzsim/streamline-eudc-configuration and the
common ancestor on master".


        Stefan

Message #32 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dgutov <at> yandex.ru>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>,
 Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration
Date: Tue, 20 Jan 2015 18:40:51 +0200

On 01/20/2015 06:35 PM, Stefan Monnier wrote:

> I must admit that my Git foo is still too limited to know/remember how
> to get the "diff between fitzsim/streamline-eudc-configuration and the
> common ancestor on master".

That would be git diff master...fitzsim/streamline-eudc-configuration, I 
believe.

Message #35 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Dmitry Gutov <dgutov <at> yandex.ru>
Cc: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>, 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration
Date: Tue, 20 Jan 2015 12:31:44 -0500

> That would be git diff master...fitzsim/streamline-eudc-configuration,
> I believe.

Indeed thanks it works now.  I had tried exactly that but with "git log"
rather than "git diff", and of course, this syntax seems specific to
"git diff".  Life would be too simple otherwise,


        Stefan

Message #38 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dgutov <at> yandex.ru>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>, 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: 24.4; [PATCH] Streamline EUDC LDAP configuration
Date: Tue, 20 Jan 2015 20:34:19 +0200

On 01/20/2015 07:31 PM, Stefan Monnier wrote:

> Indeed thanks it works now.  I had tried exactly that but with "git log"
> rather than "git diff", and of course, this syntax seems specific to
> "git diff".  Life would be too simple otherwise,

'...' is probably not supported in 'git log' because '..' already does 
what you would expect from it.

While diff can show a difference between two arbitrary trees, it's not 
like 'git log' will show "reverse" commits at the bottom.

Message #41 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Fri, 23 Jan 2015 17:22:21 -0500

> Now that the Emacs git repository is live, I've updated this patch set:
> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration
> I rebased onto 24.4, did a clean build and confirmed the functionality
> works in an emacs -Q session with minimal configuration.

This looks pretty good, thank you.  I installed it into master, with
some minor changes (most importantly, adding :version "25.1" thingies to
the custom vars you've modified).

I suggest you also put yourself as "Maintainer:" at the head of the
files, since it seems you're the best man for the job.  One more thing:
we need to add a short etc/NEWS entry describing the visible changes for
the user.  Could you provide a patch for that?


        Stefan

Message #44 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Sat, 24 Jan 2015 01:13:48 -0500

[Message part 1 (text/plain, inline)]

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>> Now that the Emacs git repository is live, I've updated this patch set:
>> https://github.com/fitzsim/emacs/tree/streamline-eudc-configuration
>> I rebased onto 24.4, did a clean build and confirmed the functionality
>> works in an emacs -Q session with minimal configuration.
>
> This looks pretty good, thank you.  I installed it into master, with
> some minor changes (most importantly, adding :version "25.1" thingies to
> the custom vars you've modified).

Thanks; defcustom :version additions and :group removals noted for next
time.

> I suggest you also put yourself as "Maintainer:" at the head of the
> files, since it seems you're the best man for the job.

OK, patch attached (I don't have push access).

> One more thing: we need to add a short etc/NEWS entry describing the
> visible changes for the user.  Could you provide a patch for that?

Attached.

Thomas

[0002-EUDC-New-maintainer.patch (text/x-patch, attachment)]

[0001-NEWS-Document-EUDC-improvements.patch (text/x-patch, attachment)]

Message #47 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Sun, 25 Jan 2015 10:07:36 -0500

> Thanks; defcustom :version additions and :group removals noted for next
> time.

The :group removals are not really important.  These just happened to be
redundant (since they referred to the group defined just above), and
since I was making changes nearby I got carried away ;-)

>> I suggest you also put yourself as "Maintainer:" at the head of the
>> files, since it seems you're the best man for the job.
> OK, patch attached (I don't have push access).

Please keep Pavel Janík's name by adding him to the list of authors, as in:

  ;; Author: Oscar Figueiredo <oscar <at> cpe.fr>
  ;;         Pavel Janík <Pavel <at> Janik.cz>
  ;; Maintainer: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>

Can you send a new patch?

>> One more thing: we need to add a short etc/NEWS entry describing the
>> visible changes for the user.  Could you provide a patch for that?
> Attached.

Thanks,


        Stefan

Message #50 received at 16322 <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
Cc: 16322 <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Sun, 25 Jan 2015 18:36:42 -0500

[Message part 1 (text/plain, inline)]

Stefan Monnier <monnier <at> IRO.UMontreal.CA> writes:

[...]

> Please keep Pavel Janík's name by adding him to the list of authors, as in:
>
>   ;; Author: Oscar Figueiredo <oscar <at> cpe.fr>
>   ;;         Pavel Janík <Pavel <at> Janik.cz>
>   ;; Maintainer: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>

I wasn't sure of the etiquette for adding myself.  Just replacing
Pavel's information did feel weird.  This is much better.  I also took
over as maintainer of eudcb-mab.el which had emacs-devel listed.

> Can you send a new patch?

Attached.

Thanks,
Thomas

[0001-EUDC-New-maintainer.patch (text/x-patch, attachment)]

Message #57 received at 16322-done <at> debbugs.gnu.org (full text, mbox):

From: Thomas Fitzsimmons <fitzsim <at> fitzsim.org>
To: 16322-done <at> debbugs.gnu.org
Subject: Re: bug#16322: Acknowledgement (24.3;
 [PATCH] Streamline EUDC LDAP configuration)
Date: Wed, 28 Jan 2015 06:25:29 -0500

fixed 16322 25.1
thanks

I pushed the EUDC maintainer and NEWS updates.  Closing.

Thomas

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.