ors-amarisoft: add more parameters for UE

software/ors-amarisoft/buildout.hash.cfg

@@ -80,11 +80,11 @@ md5sum = 36281b03597252cf75169417d02fc28c
 
 [ue-lte.jinja2.cfg]
 filename = config/ue-lte.jinja2.cfg
-md5sum = ee034558efb3e1fad4687fcd2f448872
+md5sum = b90ac384eca6fcd4249fbf0b2cf63e1e
 
 [ue-nr.jinja2.cfg]
 filename = config/ue-nr.jinja2.cfg
-md5sum = 2082bcb28d9be653225ce6db46dc236a
+md5sum = a904db3ba9518ae0edf0ddcccfa57485
 
 [sdr-busy-promise]
 _update_hash_filename_ = promise/check_sdr_busy.py

software/ors-amarisoft/config/ue-lte.jinja2.cfg

@@ -28,6 +28,12 @@ rf_driver: {
   }],
   ue_list: [
     {
+    sim_algo: "{{ slapparameter_dict.get('sim_algo', 'milenage') }}",
+    opc: "{{ slapparameter_dict.get('opc', '') }}",
+    amf: {{ slapparameter_dict.get('amf', '0x9001') }},
+    sqn: "{{ slapparameter_dict.get('sqn', '000000000000') }}",
+    impu: "{{ slapparameter_dict.get('impu', '') }}",
+    impi: "{{ slapparameter_dict.get('impi', '') }}",
     imsi: "{{ slapparameter_dict.get('imsi', slap_configuration['configuration.default_lte_imsi']) }}",
     K: "{{ slapparameter_dict.get('k', slap_configuration['configuration.default_lte_k']) }}",
     rue_addr: "{{ slapparameter_dict.get('rue_addr') }}",

software/ors-amarisoft/config/ue-nr.jinja2.cfg

@@ -29,6 +29,12 @@ rf_driver: {
     }],
     ue_list: [
       {
+      sim_algo: "{{ slapparameter_dict.get('sim_algo', 'milenage') }}",
+      opc: "{{ slapparameter_dict.get('opc', '') }}",
+      amf: {{ slapparameter_dict.get('amf', '0x9001') }},
+      sqn: "{{ slapparameter_dict.get('sqn', '000000000000') }}",
+      impu: "{{ slapparameter_dict.get('impu', '') }}",
+      impi: "{{ slapparameter_dict.get('impi', '') }}",
       imsi: "{{ slapparameter_dict.get('imsi', slap_configuration['configuration.default_nr_imsi']) }}",
       K: "{{ slapparameter_dict.get('k', slap_configuration['configuration.default_nr_k']) }}",
       rue_addr: "{{ slapparameter_dict.get('rue_addr') }}",

software/ors-amarisoft/instance-tdd1900-ue-lte-input-schema.json

@@ -56,6 +56,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd1900-ue-nr-input-schema.json

@@ -68,6 +68,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd2600-ue-lte-input-schema.json

@@ -56,6 +56,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd2600-ue-nr-input-schema.json

@@ -68,6 +68,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd3500-ue-lte-input-schema.json

@@ -56,6 +56,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd3500-ue-nr-input-schema.json

@@ -68,6 +68,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd3700-ue-lte-input-schema.json

@@ -56,6 +56,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-tdd3700-ue-nr-input-schema.json

@@ -68,6 +68,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "00112233445566778899aabbccddeeff"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-ue-lte-input-schema.json.jinja2

@@ -56,6 +56,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "{{ default_lte_k }}"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

software/ors-amarisoft/instance-ue-nr-input-schema.json.jinja2

@@ -68,6 +68,42 @@
       "description": "Set the user secret key (as a 16 bytes hexadecimal string, or eventually 32 bytes hexadecimal string for TUAK).",
       "type": "string",
       "default": "{{ default_nr_k }}"
+    },
+    "sim_algo": {
+      "title": "sim_algo",
+      "description": "Optional enumeration. xor, milenage or tuak (default = milenage). Set the USIM authentication algorithm. Note: test USIM cards use the XOR algorithm.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "opc": {
+      "title": "opc",
+      "description": "Optional string. Operator key preprocessed with the user secret key (as a 16 byte hexadecimal string). When the Milenage authentication algorithm is used, either op or opc must be set.",
+      "type": "string",
+      "default": "milenage"
+    },
+    "amf": {
+      "title": "amf",
+      "description": "Range: 0 to 65535. Set the Authentication Management Field.",
+      "type": "string",
+      "default": "0x9001"
+    },
+    "sqn": {
+      "title": "sqn",
+      "description": "Optional String (6 byte hexadecimal string). Default = '000000000000'. Set the initial sequence number. For the XOR algorithm, the actual value does not matter. For the Milenage or TUAK algorithm, a sequence number resynchronization is initiated if the sequence number does not match the one stored in the USIM.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "Array of string or object. Each string represent an IMPU and can be a sip URI or a telephone number.",
+      "type": "string",
+      "default": "000000000000"
+    },
+    "impu": {
+      "title": "impu",
+      "description": "String. Defines user IMPI. Must be fully filled with hostname if necessary.",
+      "type": "string",
+      "default": ""
     }
   }
 }

[Jérome Perrin]

@lu.xu @jhuge can you double check this, there are two parameters named impu, this causes an error in test ( https://www.erp5.com/test_result_module/20221012-18E1C994/28 ). Maybe the later was supposed to be impiu ?

[Lu Xu]

Thanks @jerome for pointing it out. Fixup: 71b09e2e

Btw, is there a way to test json schema locally (e.g. launched in theia)?

[Jérome Perrin]

Thanks @lu.xu !

that's a big yes :) in my experience, theia is excellent at editing json and jsonschema.

If you open this file in theia, you can see that the duplicate keys are underlined:

if you place the mouse cursor on it you can see the message:

there is also a "problems" pane showing all problems, but keep in mind it only shows the problem for files that you have opened, if there's a problem for a file that you did not open yet it will not display:

It's also possible to run the test locally, by following the instructions from https://lab.nexedi.com/nexedi/slapos/tree/master/software/slapos-sr-testing . Another easy way is to configure a test suite on Nexedi ERP5 by cloning SlapOS.SoftwareReleases.IntegrationTest-Master and changing it to watch the git branch you are using for development, but this can take time to tell you the result.

There is a validate-schema script at the root of the repository, but running it cause an error ( 1dc2b5dd (comment 169938) ) and I think it was not to validate the schema itself, but to validate that the parameters are valid according to the schema.

All this can be good to validate that the schema itself is valid, but there are also features that can be useful to use the schema to and edit json data that will follow the schema, probably all the documentation from https://code.visualstudio.com/docs/languages/json applies . What I like to do to check a schema is to create a "parameters.json" to try out entering parameters following the schema, for this I start with an empty json object and set the $schema key to the json schema I am editing, this way, the editor will use this schema:

and when I enter parameters I have completion:

and it also validates parameters, if the schema is strict. For example we could extend the schema like this:

and the schema would detect mistakes:

I don't know if it changing the schema like this really makes sense, I used this as an example of what's possible . When using panel.rapid.space to request an instance, there's a parameter editor, it also supports validation. I think we have started replacing it by https://rjsf-team.github.io/react-jsonschema-form/ so you can also use this tool to check that the schema is correct. Also when using slapos request it should print a warning when the request is made with parameters not matching schemas, so generally speaking in my opinion it's better to have "strict" schemas telling the user directly that something is wrong with the request.

Also, when using "enum" like on that example, the generated user interface will have a drop down and not just a text input, this screenshot is from https://rjsf-team.github.io/react-jsonschema-form/ but I think it work also with current version of panel.rapid.space:

[Thomas Gambier]

I think those explanations are great for all software developers at Nexedi. Maybe some days you can integrate them in a documentation @lu.xu

/cc @luke @rafael @xavier_thompson

[Rafael Monnerat]

Just for the record, the current problem on rely on https://rjsf-team.github.io/react-jsonschema-form/ is that its validator requires modifications on CSP of the website to allow compile. And this is is something we do not want.

Other problems is that if you use XML (and not json-in-xml), you must not rely on standard json schema since the output needs to be translated into a flat XML list of parameters. This is a limitation by design not related to any editor, that requires to rely on a specific json meta schema.

You can how your parameters works with the current form parameters at (before release of merge them):

• https://panel.rapid.space/#/?page=slap_test_parameter_form

This might be a base for future tests (even if we eventually replace it by something else).

[Jérome Perrin]

Just for the record, the current problem on rely on https://rjsf-team.github.io/react-jsonschema-form/ is that its validator requires modifications on CSP of the website to allow compile. And this is is something we do not want.

Recently ( https://github.com/rjsf-team/react-jsonschema-form/issues/2693#issuecomment-1229512829 ) there have been changes to make it possible to use another validator. Maybe we can plug another validator which does not need eval. I did not check, I was subscribed to this bug and I got the notification that it was resolved, but I could not find the time to check more.

BTW (just for me to know), wasn't it possible to host the script which needs "eval" in another web section with a different CSP only for that web section ? I think we are doing this in some places already.