JSON RPC

Module description

Signer - a subsystem that manages and stores keys and certs to sign, verify, encrypt and decrypt data. This module is included to MZI.

Operations

Delete Signer params

Context model: Params

Request data

{
    "context": {
        "op": "param_del"
    }
}

Add Signer params

Context model: Params

Request data

{
    "context": {
        "op": "param_add"
    },
    "data": {
        "sign_cert": "<sign_cert>",
        "sign_enable": "<sign_enable>",
        "validation_interval": "<validation_interval>",
        "validation_action": "<validation_action>",
        "sign_models": "<sign_models>"
    }
}

Description

sign_cert [ ] - Cert fingerprint to sign objetcs in namespace

sign_enable [ ] - Enable signing (default - no) ['yes', 'no']

validation_interval [ ] - Inverval for validation

validation_action [ ] - Action for invalid objects (default - ERROR) ['ERROR', 'WARN']

sign_models [ * ] - List of models for signing

Show Signer params

Context model: Params

Request data

{
    "context": {
        "op": "param_show"
    }
}

Update Signer params

Context model: Params

Request data

{
    "context": {
        "op": "param_update"
    },
    "data": {
        "sign_cert": "<sign_cert>",
        "sign_enable": "<sign_enable>",
        "validation_interval": "<validation_interval>",
        "validation_action": "<validation_action>",
        "sign_models": "<sign_models>"
    }
}

Description

sign_cert [ ] - Cert fingerprint to sign objetcs in namespace

sign_enable [ ] - Enable signing (default - no) ['yes', 'no']

validation_interval [ ] - Inverval for validation

validation_action [ ] - Action for invalid objects (default - ERROR) ['ERROR', 'WARN']

sign_models [ * ] - List of models for signing

Delete key

Context model: Keys

Request data

{
    "context": {
        "op": "key_del"
    },
    "data": {
        "keyid": "<keyid>"
    }
}

Description

keyid [ ] - Key ID

Add key

Context model: Keys

Request data

{
    "context": {
        "op": "key_add"
    },
    "data": {
        "algorithm": "<algorithm>",
        "expire": "<expire>",
        "descr": "<descr>"
    }
}

Description

algorithm [ ] - Key algorithm (default - rsa2048) ['rsa2048', 'rsa3072', 'rsa4096']

expire [ ] - Expire Date/ period (default - 365d)

descr [ ] - Key description

Show key

Context model: Keys

Request data

{
    "context": {
        "op": "key_show"
    },
    "data": {
        "keyid": "<keyid>"
    }
}

Description

keyid [ required ] - Key ID

List keys

Context model: Keys

Request data

{
    "context": {
        "op": "key_list"
    }
}

Delete sign file

Context model: Files

Request data

{
    "context": {
        "op": "file_del"
    },
    "data": {
        "node": "<node>",
        "filepath": "<filepath>"
    }
}

Description

node [ required ] - Node UUID

filepath [ ] - Path to file

Add sign file

Context model: Files

Request data

{
    "context": {
        "op": "file_add"
    },
    "data": {
        "node": "<node>",
        "filepath": "<filepath>",
        "descr": "<descr>"
    }
}

Description

node [ required ] - Node UUID

filepath [ required ] - Path to file

descr [ ] - Description

Show sign file

Context model: Files

Request data

{
    "context": {
        "op": "file_show"
    },
    "data": {
        "node": "<node>",
        "filepath": "<filepath>"
    }
}

Description

node [ required ] - Node UUID

filepath [ required ] - Path to file

List sign files

Context model: Files

Request data

{
    "context": {
        "op": "file_list"
    }
}

Delete sign entity

Context model: Objects

Request data

{
    "context": {
        "op": "entity_del"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - Entity name

Add sign entity

Context model: Objects

Request data

{
    "context": {
        "op": "entity_add"
    },
    "data": {
        "name": "<name>",
        "mod": "<mod>",
        "classz": "<classz>",
        "include": "<include>",
        "exclude": "<exclude>",
        "descr": "<descr>"
    }
}

Description

name [ required ] - Entity name

mod [ required ] - Plugin name

classz [ required ] - Module name

include [ * ] - List of IDs to include

exclude [ * ] - List of IDs to exclude

descr [ ] - Description

Show sign entity

Context model: Objects

Request data

{
    "context": {
        "op": "entity_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - Entity name

List sign entities

Context model: Objects

Request data

{
    "context": {
        "op": "entity_list"
    }
}

sign_entity_enable

Request data

{
    "context": {
        "op": "sign_entity_enable"
    },
    "data": {
        "pk": "<pk>",
        "force_sign": "<force_sign>"
    }
}

Description

pk [ jsonstr required ] - pk

force_sign [ str ] - force_sign

sign_entity_disable

Request data

{
    "context": {
        "op": "sign_entity_disable"
    },
    "data": {
        "pk": "<pk>"
    }
}

Description

pk [ jsonstr required ] - pk

sign_entity_del

Request data

{
    "context": {
        "op": "sign_entity_del"
    },
    "data": {
        "pk": "<pk>"
    }
}

Description

pk [ jsonstr required ] - pk

sign_entity_list

Request data

{
    "context": {
        "op": "sign_entity_list"
    },
    "data": {
        "model": "<model>"
    }
}

Description

model [ str required ] - model

sign_model_add

Request data

{
    "context": {
        "op": "sign_model_add"
    },
    "data": {
        "models": "<models>",
        "force_sign": "<force_sign>"
    }
}

Description

models [ str * required ] - models

force_sign [ str ] - force_sign

sign_model_del

Request data

{
    "context": {
        "op": "sign_model_del"
    },
    "data": {
        "models": "<models>"
    }
}

Description

models [ str * required ] - models

sign_model_list

Request data

{
    "context": {
        "op": "sign_model_list"
    }
}

Models

Files

node [ required ] - Node UUID

filepath [ ] - Path to file

descr [ ] - Description

Objects

name [ required ] - Entity name

mod [ ] - Plugin name

classz [ ] - Model name

include [ * ] - List of IDs to include

exclude [ * ] - List of IDs to exclude

descr [ ] - Description

Keys

keyid [ ] - Key ID

fingerprint [ ] - Key fingerprint

algorithm [ ] - Key algorithm (default - rsa2048) ['rsa2048', 'rsa3072', 'rsa4096']

expire [ ] - Expire Date/ period (default - 365d)

descr [ ] - Key description

Params

sign_cert [ ] - Cert fingerprint to sign objetcs in namespace

sign_enable [ ] - Enable signing (default - no) ['yes', 'no']

validation_action [ ] - Action for invalid objects (default - ERROR) ['ERROR', 'WARN']

validation_interval [ ] - Inverval for validation

sign_models [ * ] - List of models for signing

sign_objects [ jsonstr * ] - List of models for signing

sign_objects_exclude [ jsonstr * ] - List of models for signing