Traning API

[evilaliv3]

While working with GreenHost and Free Press Unlimited on the creation of a Totem course (https://totem-project.org/) we identified valuable to introduce a training API to be used by interactive training courses in order to teach users how to use the platform.

For the moment it has been analyzed a set of possible training activities for the recipients and identified that a training for a recipient should at least involve:

• Making users log in and change its own password
• Making userr log in and load their PGP key
• Making users access the tip list, and analyze a set of tips based on some task assignment
• Making users answer some answer a set of question

The analysis identified valuable the implementation of the following simple API:

• /create/account API creating a user/context
• /create/submissions/$username API creating one or multiple submissions for a user following a training scenario
• /check/$username returning a set of booleans marking the training achievements by the user.

[evilaliv3]

Names, arguments and return values are still to be properly analyzed and defined.

Preliminar analysis lead to define:

• /training/create/account API creating a user, a context and a shortlink to the submission for that user+context arguments: none return: username, password, and short url link for the submission

• /training/create/submissions/$username arguments: none (future implementation may accept a json description of the tips to be sent) return: True/False marking the success of the operation

• /training/check/$username arguments: none return: a json dictionary key/boolean marking the achievements of the user

The check API may return the following achievements status:

• logged_in: true/false
• changed_password: true/false
• loaded_pgp_key: true/false
• read_any_tip: true/false
• labeled_any_tip: true/false
• deleted_any_tip: true/false

[NCommander]

Looking at the requirements here, part of me wonders if we should just have GL work against a test copy of the database.

My biggest concern as part of the training is that we either need to mock something to be in the tip list, or let training users play with production data. We might be able to fake this by simply creating a new tenant where the training happens so if a user blows up an environment, it's not the end of the world and everything stays separate any isolated.

[marceloomens]

@NCommander my suggestion would very much be that we use a separate training deployment of Globaleaks for this. Off course its up to you if you want to expose this API by default on all deployments.

@evilaliv3 Has anything happened with this? I'm going to give the course another push now that I'm back from holiday. I've put this back on the agenda at the dev team here, to implement the edX side of things.

[evilaliv3]

thank you for getting back to us on this @marceloomens

Actually there has been no progress on this ticket as we are busy on some core activities that had to be prioritized. I will try to re-analyze it in detail at least for providing you a reasonable estimation; it is possible that we will have to schedule this activity for mid October. would that be fine with your project requirements?