[Galene] Re: Admin group creation

[Juliusz Chroboczek <jch@irif.fr>]

Hello,

> In particular I tried to create a group using PUT method with JSON body and it
> works fine for simple groups

Good.

> But if I include a "users" list or a "wildcard-user" value, it fails with a
> "description is not sanitized" error.

Right.  That's by design.

> Why is this "sanitized" check existing in UpdateDescription().

The API splits the group description into two parts:

  - the "sanitised" group description itself;
  - the users' database.

Every user, in turn, is split into two parts:

  - the user description;
  - the password.

So in order to create a group, you need to make 1 + 2n requests:

  - create the group: PUT /api/v0/.groups/groupname
  - for every user
     - create the user: PUT /api/v0/.groups/groupname/.users/username
     - set the password: PUT /api/v0/.groups/groupname/.users/username/.password

You use .wildcard-user for the wildcard user.

The main reason why I've used this organisation is that it makes
fine-grained access control possible: for example, a normal (non-admin)
user is allowed to change their own password, but they're of course not
allowed to change the rest of the group description.  Conversely, an admin
is allowed to change the group description, but they're not allowed to GET
a password.

(There are other advantages, but they're less important, so I won't bore
you with them here.)

The main drawback, of course, is that it makes some operations
inefficient.  For example, in order to display the list of users together
with their persmissions, you need to do this:

  GET /api/v0/.groups/groupname/.users/
  for every user
      GET /api/v0/.groups/groupname/.users/username

(It also makes the operation non-atomic: if a user is deleted between the
first and the subsequent GET, then you'll unexpectedly get a 404 error.
Oh, well.)

If it becomes a problem in the future, I'll extend the API with operations
over collections, but until we gain more experience with the API, I'd
rather stick to simple operations only.

By the way: the main user of the API right now is the galenectl program,
which you're find in the Galene sources.  Feel free to copy-paste code
from there.

I hope this helps,

-- Juliusz Chroboczek