scripts

FEUDAL Scripts Version 3

FEUDAL scripts (also called adapters) are used to deploy feudal users in a customizable fashion. They are executed by a feudalClient and have a specific input and output.

This go library can be used as a basis to implement such a script. Examples can be found here: a simple stub, creating SSH access, and handling questionnaires.

The scripts use json for input and output. The specific formats are outlined below. The input is passed to the scripts via stdin.

The feudalClient can be used to generate and validate json schema for input and output, see:

   feudalClient schema --help
   feudalClient validate --help

Input Format

{
    // The state which is to be reached by this script execution
    //
    // deployed     -> the script is supposed to deploy the user
    // not_deployed -> the script is supposed to remove the user
    "state_target": "deployed" or "not_deployed",


    // The user which is requesting access
    "user": {
        "userinfo": <OpenID Connect userinfo as json dict>

        // The credentials from the user, which need to be deployed
        // The dict maps a credential type to a list of credentials of this type.
        "credentials": {
            "ssh_key": [
                {
                    "name": "unity_key",
                    "value": "ssh-... ..."
                }
            ]
        },
    },


    // Answers to a previously requested questionnaire, may not be present
    "answers": {
      "question_name": "user answer to this question",
      "age_question": 18,
      "list_question": "person_a",
      "list_question_2": 2,
      "are_you_sure": true
    }
}

Output Format

{
    // The state as of now (after the script run)
    //
    // deployed     -> The deployment was processed successfully
    // not_deployed -> The removal of the user was processed successfully
    // failed       -> An error occured and the script could not reach the 'state_target' from the Input
    // rejected     -> The user is not permitted to use this service, for whatever reason
    // questionnaire-> The script needs more information to deploy the user
    "state": "deployed" or "not_deployed" or "failed" or "rejected" or "questionnaire",


    "message": "<message for the user describing what happened. Must not be empty.",

    // In case we need more info from the user: set state to "questionnaire" and put
    // questions in this dictionary.
    // The user can answer these questions (and we will receive the answers some input in the future)
    "questionnaire": {
        "question_name": "question",
        "age_question": "How old are you?",
        "list_question": "Who are you?",
        "list_question_2": "How many do you want?",
        "are_you_sure": "What you are trying is wrong. Are you sure?"
    },

    // By default questions in questionnaire expect answers are strings. You can change this here:
    // Add a mapping with the same key here
    "questionnaire_answers": {
        "question_name": "question",                    // string default value
        "age_question": 18,                             // age_question must be an integer, defaulting to 18
        "list_question": ["person_a", "person_b"],      // list_question must be one of the listed options
        "list_question_2": [1, 2],                      // list_question_2 must be one of the listed options
        "are_you_sure": false                          // are_you_sure must be a boolean, with false being the default value
    },

    // additional credentials and instructions, the user needs to access the service (in addition to her credentials from the Input)
    // an example would be the user name of the provisioned user.
    "credentials": {
        "key": "value"
    }
}