From mboxrd@z Thu Jan  1 00:00:00 1970
From: Andy Wingo <wingo@igalia.com>
Subject: Re: [PATCH] openssh service
Date: Fri, 26 Aug 2016 12:51:56 +0200
Message-ID: <8737lrby5v.fsf@igalia.com>
References: <20160805141840.447dd381@polymos> <87oa57jpix.fsf@igalia.com>
	<20160805162049.491063d9@polymos> <20160819160335.3ed70813@polymos>
	<CAEwRq=q7wFGp5eu-J-igSJvW9pbn7848q4viM_e61tP3ixU86w@mail.gmail.com>
	<20160819163125.0be91283@polymos>
Mime-Version: 1.0
Content-Type: text/plain
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:42579)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <wingo@igalia.com>) id 1bdEkb-0007wK-Do
	for guix-devel@gnu.org; Fri, 26 Aug 2016 06:52:42 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <wingo@igalia.com>) id 1bdEkX-0007lC-A0
	for guix-devel@gnu.org; Fri, 26 Aug 2016 06:52:40 -0400
Received: from pb-sasl2.pobox.com ([64.147.108.67]:55095
	helo=sasl.smtp.pobox.com) by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <wingo@igalia.com>) id 1bdEkX-0007aQ-39
	for guix-devel@gnu.org; Fri, 26 Aug 2016 06:52:37 -0400
In-Reply-To: <20160819163125.0be91283@polymos> (Julien Lepiller's message of
	"Fri, 19 Aug 2016 16:31:25 +0200")
List-Id: "Development of GNU Guix and the GNU System distribution."
	<guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/guix-devel/>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=subscribe>
Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org
Sender: "Guix-devel" <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
To: Julien Lepiller <julien@lepiller.eu>
Cc: guix-devel <guix-devel@gnu.org>

Hi Julien,

Thanks for the documentation update!

On Fri 19 Aug 2016 16:31, Julien Lepiller <julien@lepiller.eu> writes:

> +@deffn {Scheme Procedure} openssh-service [#:pidfile "/var/run/sshd.pid"] @
> +       [#:port-number 22] [#:root-login "without-password"] @
> +       [#:allow-empty-passwords #f] [#:password-authentication? #t] @
> +       [#:pubkey-authentication? #t] [#:rsa-authentication? #t] @
> +       [#:x11-forwarding? #f] [#:protocol-number "2"]
> +"Run the @command{sshd} program from @var{openssh} on port @var{port-number}.
> +@command{sshd} runs an ssh daemon and writes its PID to @var{pidfile}. It
> +understands ssh protocol @var{protocol-number}. The @var{protocol-number} can
> +be one of \"1\", \"2\" or \"1,2\".
> +
> +@var{PermitRootLogin} takes one of @var{yes}, @var{without-password} and
> +@var{no}. It is used to allow root login through ssh. @var{without-password}
> +means that root login is allowed, except when loging with a password (eg: a
> +public key).

The variable needs to be changed to @var{root-login} (and I think
probably @var{permit-root-login} would be more expected), and probably
"without-password" should be a symbol rather than a string.  In general
I think naming the keywords after the upstream options is going to be
the least confusing thing for users.  Consider changing from
yes/no/without-password to #t/#f/without-password, and renaming the
option to #:permit-root-login?.  Consider requiring that the protocol
number be either 1 or 2.  In general we want to make errors happen
early, when building the OS, rather than when the OS is booted.

WDYT?

Andy