June 2026 - gerrit-log - lists.osmocom.org

[M] Change in onomondo-eim[master]: esipa_rest_utils: add support for PSMOs added in SGP.32 V.1.2
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42881?usp=email ) Change subject: esipa_rest_utils: add support for PSMOs added in SGP.32 V.1.2 ...................................................................... esipa_rest_utils: add support for PSMOs added in SGP.32 V.1.2 SGP.32 adds 3 additional PSMOs: - setFallbackAttribute - unsetFallbackAttribute - setDefaultDpAddress Change-Id: I03cdd70065a83dfc611d614cf32d817c13fad347 Related: SYS#8100 --- M contrib/rest_api_resource_schema.json M contrib/rest_api_response_schema.json M src/esipa_rest_utils.erl 3 files changed, 113 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/81/42881/1 diff --git a/contrib/rest_api_resource_schema.json b/contrib/rest_api_resource_schema.json index 1bc0fcf..21ce5d2 100644 --- a/contrib/rest_api_resource_schema.json +++ b/contrib/rest_api_resource_schema.json @@ -157,6 +157,44 @@ "immediateEnableFlag" ] } + }, + { + "unsetFallbackAttribute": { + "description": "order the execution of a setFallbackAttribute PSMO, see also GSMA SGP.32, section 3.4.6", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "unsetFallbackAttribute": { + "description": "order the execution of a unsetFallbackAttribute PSMO, see also GSMA SGP.32, section 3.4.7", + "type": "object", + "properties": {} + } + }, + { + "setDefaultDpAddress": { + "description": "order the execution of a setDefaultDpAddress PSMO, see also GSMA SGP.32, section 5.9.25", + "type": "object", + "properties": { + "defaultDpAddress": { + "description": "Address of the default SM-DP+", + "type": "string" + } + }, + "required": [ + "defaultDpAddress" + ] + } } ] } diff --git a/contrib/rest_api_response_schema.json b/contrib/rest_api_response_schema.json index c36c6c7..5f09bc1 100644 --- a/contrib/rest_api_response_schema.json +++ b/contrib/rest_api_response_schema.json @@ -207,6 +207,42 @@ } }, { + "setFallbackAttributeResult": { + "description": "setFallbackAttributeResult PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "fallbackNotAllowed", + "fallbackProfileEnabled", + "undefinedError" + ] + } + }, + { + "unsetFallbackAttributeResult": { + "description": "unsetFallbackAttributeResult PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "noFallbackAttribute", + "fallbackProfileEnabled", + "commandError", + "undefinedError" + ] + } + }, + { + "setDefaultDpAddressResult": { + "description": "setDefaultDpAddressResult PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "undefinedError" + ] + } + }, + { "addEimResult": { "description": "addEimResult eCO result", "type": "object", diff --git a/src/esipa_rest_utils.erl b/src/esipa_rest_utils.erl index 2d2c7fe..936e6fa 100644 --- a/src/esipa_rest_utils.erl +++ b/src/esipa_rest_utils.erl @@ -136,6 +136,33 @@ error end. +psmo_to_asn_setFallbackAttribute(Psmo) -> + case Psmo of + {[{<<"iccid">>, Iccid}]} -> + {setFallbackAttribute, #{iccid => utils:hex_to_binary(Iccid)}}; + _ -> + logger:error("REST: order with bad setFallbackAttribute PSMO: ~p~n", [Psmo]), + error + end. + +psmo_to_asn_unsetFallbackAttribute(Psmo) -> + case Psmo of + {[]} -> + {unsetFallbackAttribute, #{}}; + _ -> + logger:error("REST: order with bad unsetFallbackAttribute PSMO: ~p~n", [Psmo]), + error + end. + +psmo_to_asn_setDefaultDpAddress(Psmo) -> + case Psmo of + {[{<<"defaultDpAddress">>, DefaultDpAddress}]} -> + {setDefaultDpAddress, #{defaultDpAddress => DefaultDpAddress}}; + _ -> + logger:error("REST: order with bad setDefaultDpAddress PSMO: ~p~n", [Psmo]), + error + end. + format_euicc_EuiccPackageSigned(EuiccPackage, EidValue, TransactionId) -> case EuiccPackage of error -> @@ -169,6 +196,12 @@ psmo_to_asn_getRAT(Psmo); {[{<<"configureImmediateEnable">>, Psmo}]} -> psmo_to_asn_configureImmediateEnable(Psmo); + {[{<<"setFallbackAttribute">>, Psmo}]} -> + psmo_to_asn_setFallbackAttribute(Psmo); + {[{<<"unsetFallbackAttribute">>, Psmo}]} -> + psmo_to_asn_unsetFallbackAttribute(Psmo); + {[{<<"setDefaultDpAddress">>, Psmo}]} -> + psmo_to_asn_setDefaultDpAddress(Psmo); _ -> logger:error("REST: order with unknown/unsupported PSMO: ~p~n", [PsmoOrder]), error @@ -396,6 +429,12 @@ result_to_json_getRATResult(GetRATResult); {configureImmediateEnableResult, ConfigureImmediateEnableResult} -> {[{configureImmediateEnableResult, ConfigureImmediateEnableResult}]}; + {setFallbackAttributeResult, SetFallbackAttributeResult} -> + {[{setFallbackAttributeResult, SetFallbackAttributeResult}]}; + {unsetFallbackAttributeResult, UnsetFallbackAttributeResult} -> + {[{unsetFallbackAttributeResult, UnsetFallbackAttributeResult}]}; + {setDefaultDpAddressResult, SetDefaultDpAddressResult} -> + {[{setDefaultDpAddressResult, maps:get(setDefaultDpAddressResult, SetDefaultDpAddressResult)}]}; {addEimResult, AddEimResult} -> result_to_json_addEimResult(AddEimResult); {deleteEimResult, DeleteEimResult} -> -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42881?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I03cdd70065a83dfc611d614cf32d817c13fad347 Gerrit-Change-Number: 42881 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[S] Change in onomondo-eim[master]: eim_cfg: set eimSupportedProtocol and indirectProfileDownload flags
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42882?usp=email ) Change subject: eim_cfg: set eimSupportedProtocol and indirectProfileDownload flags ...................................................................... eim_cfg: set eimSupportedProtocol and indirectProfileDownload flags The members eimSupportedProtocol and indirectProfileDownload were added as optional members to EimConfigurationData with SGP.32 V.1.2. Since our eIM implementation only supports eIM Package Retrieval via HTTPs and the Indirect Profile Download procedure is the only Profile Download procedure we currently support, the EimConfigurationData should reflect those properties correctly. (The EimConfigurationData is not announced actively by the eIM, but this eIM implementation contains a generator to help with the encoding of the EimConfigurationData that is programmed into the eUICC) Change-Id: I4ce236fb1bfb8a3790191be95ab0958dce13a9d8 Related: SYS#8100 --- M src/eim_cfg.erl 1 file changed, 8 insertions(+), 2 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/82/42882/1 diff --git a/src/eim_cfg.erl b/src/eim_cfg.erl index f74ccd8..4f15a42 100644 --- a/src/eim_cfg.erl +++ b/src/eim_cfg.erl @@ -46,10 +46,16 @@ eimFqdn => EimFqdn, % Mandatory counterValue => CounterValue, - %Optional: instruct the eUICC to calculate an association token + % Optional: instruct the eUICC to calculate an association token associationToken => -1, % Mandatory - eimPublicKeyData => {eimPublicKey, EimCert_SubjectPublicKeyInfo} + eimPublicKeyData => {eimPublicKey, EimCert_SubjectPublicKeyInfo}, + % This eIM implementation currently only supports ESipa via HTTPs where the only supported eIM Package + % transfer procedure is the eIM Package Retrieval procedure (see also SGP.32, section 3.1.1.1. + eimSupportedProtocol => [eimRetrieveHttps], + % The Indirect Profile Download (see also SGP.32, section 3.2.3.2) is currently the only supported Profile + % Download procedure, which is supported by this eIM implementation. + indirectProfileDownload => true }, EimConfigurationDataList = [EimConfigurationData], AddInitialEimRequest = #{eimConfigurationDataList => EimConfigurationDataList}, -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42882?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I4ce236fb1bfb8a3790191be95ab0958dce13a9d8 Gerrit-Change-Number: 42882 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XS] Change in onomondo-eim[master]: esipa_rest_utils: align IpaEuiccDataResponse to SGP.32 V.1.2
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42883?usp=email ) Change subject: esipa_rest_utils: align IpaEuiccDataResponse to SGP.32 V.1.2 ...................................................................... esipa_rest_utils: align IpaEuiccDataResponse to SGP.32 V.1.2 The ASN.1 struct IpaEuiccDataResponse has renamed the error code member from ipaEuiccDataError to ipaEuiccDataErrorCode. The new ipaEuiccDataErrorCode is a sequence that has an ipaEuiccDataErrorCode member, which is the equivalent of the previously existing ipaEuiccDataError member. See also: SGP.32, section 2.11.2.2 Change-Id: Ie734a09ed4b0d57de30dc6fb377dfada79ea2ae4 Related: SYS#8100 --- M src/esipa_rest_utils.erl 1 file changed, 2 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/83/42883/1 diff --git a/src/esipa_rest_utils.erl b/src/esipa_rest_utils.erl index 936e6fa..c2565b5 100644 --- a/src/esipa_rest_utils.erl +++ b/src/esipa_rest_utils.erl @@ -550,7 +550,8 @@ IpaEuiccDataJsonFiltered = {lists:filter(fun(Member) -> Member /= nil end, IpaEuiccDataJson)}, [{[{euiccDataResult, {[{edrResult, ok}, {euiccData, IpaEuiccDataJsonFiltered}]}}]}]; - {ipaEuiccDataError, IpaEuiccDataError} -> + {ipaEuiccDataResponseError, IpaEuiccDataResponseError} -> + IpaEuiccDataError = maps:get(ipaEuiccDataErrorCode, IpaEuiccDataResponseError), [{[{euiccDataResult, {[{edrResult, IpaEuiccDataError}]}}]}]; _ -> [{[{euiccDataResult, {[{edrResult, undefinedError}]}}]}] -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42883?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: Ie734a09ed4b0d57de30dc6fb377dfada79ea2ae4 Gerrit-Change-Number: 42883 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XS] Change in onomondo-eim[master]: rest_api_response_schema: add missing error codes
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42884?usp=email ) Change subject: rest_api_response_schema: add missing error codes ...................................................................... rest_api_response_schema: add missing error codes In SGP.32 V.1.2, new error codes were added to EnableProfileResult, DisableProfileResult, DeleteProfileResult and AddEimResult See also: SGP.32, section 2.11.2 Change-Id: I525ca9d3b7fb870405d374160272d8ec26c85880 Related: SYS#8100 --- M contrib/rest_api_response_schema.json 1 file changed, 9 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/84/42884/1 diff --git a/contrib/rest_api_response_schema.json b/contrib/rest_api_response_schema.json index 5f09bc1..499b73b 100644 --- a/contrib/rest_api_response_schema.json +++ b/contrib/rest_api_response_schema.json @@ -37,6 +37,9 @@ "ok", "iccidOrAidNotFound", "profileNotInDisabledState", + "disallowedByPolicy", + "catBusy", + "rollbackNotAvailable", "undefinedError" ] } @@ -49,6 +52,8 @@ "ok", "iccidOrAidNotFound", "profileNotInEnabledState", + "disallowedByPolicy", + "catBusy", "undefinedError" ] } @@ -61,6 +66,9 @@ "ok", "iccidOrAidNotFound", "profileNotInDisabledState", + "disallowedByPolicy", + "rollbackNotAvailable", + "returnFallbackProfile", "undefinedError" ] } @@ -253,6 +261,7 @@ "enum": [ "ok", "insufficientMemory", + "associatedEimAlreadyExists", "ciPKUnknown", "invalidAssociationToken", "counterValueOutOfRange", -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42884?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I525ca9d3b7fb870405d374160272d8ec26c85880 Gerrit-Change-Number: 42884 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XL] Change in onomondo-eim[master]: rest_api: revert json schema re-formatting
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42879?usp=email ) Change subject: rest_api: revert json schema re-formatting ...................................................................... rest_api: revert json schema re-formatting The JSON schema got reformatted in patch 78810e9d0e2c4fcfa0bff2e16aedd225c7145055, however, the reformatted version now follows a scheme that is incompatible with the emacs default settings. This makes it very hard to work with those files, so let's revert this change. Change-Id: I2361891875a8e190fff7003196c2df76fd877080 Related: SYS#8100 --- M contrib/rest_api_info_schema.json M contrib/rest_api_resource_schema.json M contrib/rest_api_response_schema.json 3 files changed, 829 insertions(+), 829 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/79/42879/1 diff --git a/contrib/rest_api_info_schema.json b/contrib/rest_api_info_schema.json index d808dd6..2bf1291 100644 --- a/contrib/rest_api_info_schema.json +++ b/contrib/rest_api_info_schema.json @@ -1,61 +1,61 @@ { - "$id": "https://onomondo.com/schemas/info", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API info", - "type": "object", - "properties": { - "hostname": { - "description": "hostname of the machine where onomondo-eim is running on", - "type": "string" - }, - "node": { - "description": "erlang node name of the onomondo-eim instance", - "type": "string" - }, - "version": { - "description": "version number of the onomondo-eim instance", - "type": "string" - }, - "eimId": { - "description": "eIM identifier (see also GSMA GSP.32)", - "type": "string" - }, - "esipaIp": { - "description": "IP-Address where the ESipa interface is bound to", - "type": "string" - }, - "esipaPort": { - "description": "IP-Port where the ESipa interface is bound to", - "type": "string" - }, - "esipaSslCert": { - "description": "SSL certificate that is used for the ESipa interface (HTTPS)", - "type": "string" - }, - "eimCert": { - "description": "eIM certificate (used for creating signatures)", - "type": "string" - }, - "rootCiCerts": { - "description": "List of configured eUICC root CI certificates", - "type": "array", - "items": { - "type": "string" - } - }, - "addInitialEimRequest": { - "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "eimConfigurationData": { - "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "counterValue": { - "description": "Initial counter value for signature generation (see also GSMA SGP.32)", - "type": "integer" + "$id": "https://onomondo.com/schemas/info", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API info", + "type": "object", + "properties": { + "hostname": { + "description": "hostname of the machine where onomondo-eim is running on", + "type": "string" + }, + "node": { + "description": "erlang node name of the onomondo-eim instance", + "type": "string" + }, + "version": { + "description": "version number of the onomondo-eim instance", + "type": "string" + }, + "eimId": { + "description": "eIM identifier (see also GSMA GSP.32)", + "type": "string" + }, + "esipaIp": { + "description": "IP-Address where the ESipa interface is bound to", + "type": "string" + }, + "esipaPort": { + "description": "IP-Port where the ESipa interface is bound to", + "type": "string" + }, + "esipaSslCert": { + "description": "SSL certificate that is used for the ESipa interface (HTTPS)", + "type": "string" + }, + "eimCert": { + "description": "eIM certificate (used for creating signatures)", + "type": "string" + }, + "rootCiCerts": { + "description": "List of configured eUICC root CI certificates", + "type": "array", + "items": { + "type": "string" + } + }, + "addInitialEimRequest": { + "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "eimConfigurationData": { + "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "counterValue": { + "description": "Initial counter value for signature generation (see also GSMA SGP.32)", + "type": "integer" + } } - } } diff --git a/contrib/rest_api_resource_schema.json b/contrib/rest_api_resource_schema.json index 27726ff..12fd049 100644 --- a/contrib/rest_api_resource_schema.json +++ b/contrib/rest_api_resource_schema.json @@ -1,285 +1,285 @@ { - "$id": "https://onomondo.com/schemas/resource", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API resource", - "type": "object", - "properties": { - "eidValue": { - "description": "EID value of the eUICC to be addressed", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "order": { - "description": "Order to be executed", - "type": "object", - "anyOf": [ - { - "download": { - "description": "order to trigger a profile download", - "type": "object", - "properties": { - "activationCode": { - "description": "see GSMA SGP.22, section 4.1", - "type": "string" - }, - "required": [ - "activationCode" - ] - } - } - }, - { - "psmo": { - "description": "order the execution of a PSMO, see also GSMA SGP.32, section 2.11.1.1.2", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "enable": { - "description": "order the execution of a profile enable PSMO, see also GSMA SGP.32, section 3.4.1", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "rollback": { - "description": "see also GSMA SGP.32, section 3.4.1, subsection 'Profile Rollback Procedure'", - "type": "boolean" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "disable": { - "description": "order the execution of a profile disable PSMO, see also GSMA SGP.32, section 3.4.2", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "delete": { - "description": "order the execution of a profile delete PSMO, see also GSMA SGP.32, section 3.4.3", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "listProfileInfo": { - "description": "order the execution of a listProfileInfo PSMO", - "type": "object", - "properties": { - "searchCriteria": { - "anyOf": [ - { - "isdpAid": { - "description": "AID of the ISDP (identifies a profile)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - { - "profileClass": { - "description": "0=test, 1=provisioning, 2=operational", - "type": "integer" - } - } - ] - }, - "taglist": { - "description": "concatonation of the BER-TLV tags that shall be included in the response", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "searchCriteria" - ] - } - } - }, - { - "getRAT": { - "description": "order the execution of a getRAT PSMO, see also GSMA SGP.32, section 5.9.13", - "type": "object", - "properties": {} - } - }, - { - "configureImmediateEnable": { - "description": "order the execution of a configureImmediateEnable PSMO, see also GSMA SGP.32, section 5.13.6", - "type": "object", - "properties": { - "immediateEnableFlag": { - "description": "enable/disable automatic profile enabeling", - "type": "boolean" - }, - "defaultSmdpOid": { - "description": "object ID of the default SMDP+", - "type": "string" - }, - "defaultSmdpAddress": { - "description": "FQDN of the default SMDP+", - "type": "string" - }, - "required": [ - "immediateEnableFlag" - ] - } - } - } - ] - } - } - } - }, - { - "eco": { - "description": "order the execition of a eCO, see also GSMA SGP.32, section 2.11.1.1.3", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "addEim": { - "description": "add an eIM", - "type": "object", - "properties": { - "eimConfigurationData": { - "description": "ASN.1 encoded EimConfigurationData", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "eimConfigurationData" - ] - } - }, - { - "deleteEim": { - "description": "delete an eIM", - "type": "object", - "properties": { - "eimId": { - "description": "eimId of the eIM", - "type": "string" - } - }, - "required": [ - "eimId" - ] - } - }, - { - "updateEim": { - "description": "update an eIM", - "type": "object", - "properties": { - "eimConfigurationData": { - "description": "ASN.1 encoded EimConfigurationData", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "eimConfigurationData" - ] - } - }, - { - "listEim": { - "description": "list all configured eIMs", - "type": "object", - "properties": {} - } - } - ] - } - } - } - }, - { - "edr": { - "description": "order to perform an IpaEuiccDataRequest", - "type": "object", - "properties": { - "tagList": { - "description": "see GSMA SGP.32, section 2.11.1.2", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "tagList" - ] - } - } - }, - { - "euicc": { - "description": "set a parameter in the euicc master data table", - "type": "array", - "items": { - "counterValue": { - "description": "sets the signature counter to a specified value (use with caution)", - "type": "integer" - }, - "consumerEuicc": { - "description": "tells the eIM that the remote end (IPAd) uses a consumer eUICC with an IoT eUICC emulation mode", - "type": "boolean" - }, - "associationToken": { - "description": "association token that the eUICC uses to identify this eIM internally", - "type": "integer" - }, - "signAlgo": { - "description": "algorithm to be used for checking eUICC package results", - "type": "string", - "enum": [ - "prime256v1", - "brainpoolP256r1" - ] - }, - "signPubKey": { - "description": "public key to be used for checking eUICC package results", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - } - } - } - ] + "$id": "https://onomondo.com/schemas/resource", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API resource", + "type": "object", + "properties": { + "eidValue": { + "description": "EID value of the eUICC to be addressed", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "order": { + "description": "Order to be executed", + "type": "object", + "anyOf": [ + { + "download": { + "description": "order to trigger a profile download", + "type": "object", + "properties": { + "activationCode": { + "description": "see GSMA SGP.22, section 4.1", + "type": "string" + }, + "required": [ + "activationCode" + ] + } + } + }, + { + "psmo": { + "description": "order the execution of a PSMO, see also GSMA SGP.32, section 2.11.1.1.2", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "enable": { + "description": "order the execution of a profile enable PSMO, see also GSMA SGP.32, section 3.4.1", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "rollback": { + "description": "see also GSMA SGP.32, section 3.4.1, subsection 'Profile Rollback Procedure'", + "type": "boolean" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "disable": { + "description": "order the execution of a profile disable PSMO, see also GSMA SGP.32, section 3.4.2", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "delete": { + "description": "order the execution of a profile delete PSMO, see also GSMA SGP.32, section 3.4.3", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "listProfileInfo": { + "description": "order the execution of a listProfileInfo PSMO", + "type": "object", + "properties": { + "searchCriteria": { + "anyOf": [ + { + "isdpAid": { + "description": "AID of the ISDP (identifies a profile)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + { + "profileClass": { + "description": "0=test, 1=provisioning, 2=operational", + "type": "integer" + } + } + ] + }, + "taglist": { + "description": "concatonation of the BER-TLV tags that shall be included in the response", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "searchCriteria" + ] + } + } + }, + { + "getRAT": { + "description": "order the execution of a getRAT PSMO, see also GSMA SGP.32, section 5.9.13", + "type": "object", + "properties": {} + } + }, + { + "configureImmediateEnable": { + "description": "order the execution of a configureImmediateEnable PSMO, see also GSMA SGP.32, section 5.13.6", + "type": "object", + "properties": { + "immediateEnableFlag": { + "description": "enable/disable automatic profile enabeling", + "type": "boolean" + }, + "defaultSmdpOid": { + "description": "object ID of the default SMDP+", + "type": "string" + }, + "defaultSmdpAddress": { + "description": "FQDN of the default SMDP+", + "type": "string" + }, + "required": [ + "immediateEnableFlag" + ] + } + } + } + ] + } + } + } + }, + { + "eco": { + "description": "order the execition of a eCO, see also GSMA SGP.32, section 2.11.1.1.3", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "addEim": { + "description": "add an eIM", + "type": "object", + "properties": { + "eimConfigurationData": { + "description": "ASN.1 encoded EimConfigurationData", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "eimConfigurationData" + ] + } + }, + { + "deleteEim": { + "description": "delete an eIM", + "type": "object", + "properties": { + "eimId": { + "description": "eimId of the eIM", + "type": "string" + } + }, + "required": [ + "eimId" + ] + } + }, + { + "updateEim": { + "description": "update an eIM", + "type": "object", + "properties": { + "eimConfigurationData": { + "description": "ASN.1 encoded EimConfigurationData", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "eimConfigurationData" + ] + } + }, + { + "listEim": { + "description": "list all configured eIMs", + "type": "object", + "properties": {} + } + } + ] + } + } + } + }, + { + "edr": { + "description": "order to perform an IpaEuiccDataRequest", + "type": "object", + "properties": { + "tagList": { + "description": "see GSMA SGP.32, section 2.11.1.2", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "tagList" + ] + } + } + }, + { + "euicc": { + "description": "set a parameter in the euicc master data table", + "type": "array", + "items": { + "counterValue": { + "description": "sets the signature counter to a specified value (use with caution)", + "type": "integer" + }, + "consumerEuicc": { + "description": "tells the eIM that the remote end (IPAd) uses a consumer eUICC with an IoT eUICC emulation mode", + "type": "boolean" + }, + "associationToken": { + "description": "association token that the eUICC uses to identify this eIM internally", + "type": "integer" + }, + "signAlgo": { + "description": "algorithm to be used for checking eUICC package results", + "type": "string", + "enum": [ + "prime256v1", + "brainpoolP256r1" + ] + }, + "signPubKey": { + "description": "public key to be used for checking eUICC package results", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + } + } + } + ] + } } - } } diff --git a/contrib/rest_api_response_schema.json b/contrib/rest_api_response_schema.json index 5b00450..45ccb79 100644 --- a/contrib/rest_api_response_schema.json +++ b/contrib/rest_api_response_schema.json @@ -1,492 +1,492 @@ { - "$id": "https://onomondo.com/schemas/response", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API response", - "type": "object", - "properties": { - "status": { - "description": "general processing status of the order", - "type": "string", - "enum": [ - "new", - "work", - "done", - "deleted", - "absent" - ] - }, - "timestamp": { - "description": "unix-timestamp of the last status update", - "type": "string" - }, - "resource": { - "$ref": "/schemas/resource" - }, - "outcome": { - "description": "specific result if the executed order", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "enableResult": { - "description": "profile enable PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInDisabledState", - "undefinedError" - ] - } - }, - { - "disableResult": { - "description": "profile disable PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInEnabledState", - "undefinedError" - ] - } - }, - { - "deleteResult": { - "description": "profile delete PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInDisabledState", - "undefinedError" - ] - } - }, - { - "listProfileInfoResult": { - "description": "listProfileInfoResult PSMO result, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "successResult", - "errorResult" - ] - }, - "profileInfoList": { - "description": "contains a list of installed profiles and their meta data, see also RSPDefinitions.asn1", - "type": "array", - "items": { - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "isdpAid": { - "description": "AID of the ISDP (identifies a profile)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "profileState": { - "description": "usage state of the prifle", - "type": "string", - "enum": [ - "disabled", - "enabled" - ] - }, - "profileNickname": { - "description": "human readable nickname name of the profile", - "type": "string" - }, - "serviceProviderName": { - "description": "human readable name of the related service provider", - "type": "string" - }, - "profileName": { - "description": "human readable name of the profile", - "type": "string" - }, - "iconType": { - "description": "graphics format in which the profile icon is supplied", - "type": "string" - }, - "icon": { - "description": "icon graphic", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "profileClass": { - "description": "0=test, 1=provisioning, 2=operational", - "type": "integer" - } - } - } - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "getRATResult": { - "description": "getRAT (rules authorization table) PSMO result, see also RSPDefinitions.asn1", - "type": "array", - "items": { - "type": "object", - "properties": { - "pprUpdateControl": { - "description": "defines how to update PPRs via ES6", - "type": "boolean" - }, - "ppr1": { - "description": "Indicator for PPR1 'Disabling of this Profile is not allowed'", - "type": "boolean" - }, - "ppr2": { - "description": "Indicator for PPR2 'Deletion of this Profile is not allowed'", - "type": "boolean" - }, - "allowedOperators": { - "description": "list of allowed operaters, see also GSMA SGP.22, section 2.9.2.1", - "type": "array", - "items": { - "mccMnc": { - "description": "MCC and MNC coded as defined in 3GPP TS 24.008", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "gid1": { - "description": "referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "gid2": { - "description": "referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "mccMnc" - ] - } - }, - "consentRequired": { - "description": "indicates that the End User consent is required", - "type": "boolean" - }, - "required": [ - "pprUpdateControl", - "ppr1", - "ppr2", - "allowedOperators", - "consentRequired" - ] - } - } - } - }, - { - "configureImmediateEnableResult": { - "description": "configureImmediateEnableResult (automatic profile enabeling) PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "insufficientMemory", - "commandError", - "undefinedError" - ] - } - }, - { - "addEimResult": { - "description": "addEimResult eCO result", - "type": "object", - "properties": { - "addEimResultCode": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "ok", - "insufficientMemory", - "ciPKUnknown", - "invalidAssociationToken", - "counterValueOutOfRange", - "commandError", - "undefinedError", - "malformedResult" - ] - }, - "associationToken": { - "description": "resulting association token, see also GSMA SGP.32, section 2.11.1.1.1", - "type": "integer" - }, - "required": [ - "addEimResultCode" - ] - } - } - }, - { - "deleteEimResult": { - "description": "deleteEimResult eCO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "eimNotFound", - "lastEimDeleted", - "commandError", - "undefinedError" - ] - } - }, - { - "updateEimResult": { - "description": "updateEimResult eCO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "eimNotFound", - "ciPKUnknown", - "counterValueOutOfRange", - "commandError", - "undefinedError" - ] - } - }, - { - "listEimResult": { - "description": "listEimResult eCO result, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "successResult", - "errorResult" - ] - }, - "eimIdList": { - "description": "list containing the IDs of all configured eIM servers", - "type": "array", - "items": { - "eimId": { - "description": "eIM ID", - "type": "string" - }, - "eimIdType": { - "description": "specifies the type of the eIM ID", - "type": "string", - "enum": [ - "eimIdTypeOid", - "eimIdTypeFqdn", - "eimIdTypeProprietary" - ] - }, - "required": [ - "eimId" - ] - } - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "rollbackResult": { - "description": "Status code of the execution of a profile rollback maneuver, see also GSMA SGP.32, section 2.11.1.13 and SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "undefinedError" - ] - } - }, - { - "processingTerminated": { - "description": "Error code in case the eUICC has terminated the overall eUICC package execution, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "resultSizeOverflow", - "unknownOrDamagedCommand", - "interruption", - "undefinedError" - ] - } - }, - { - "notificationResult": { - "description": "Status code to indicate that an otherSignedNotification has been received", - "type": "string", - "enum": [ - "otherSignedNotification" - ] - } - }, - { - "cancelSessionResult": { - "description": "Status code to indicate that the session has been canceled", - "type": "string", - "enum": [ - "ok", - "undefinedError" - ] - } - }, - { - "profileInstallationResult": { - "description": "Final result of a profile download, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about succes or failure", - "enum": [ - "successResult", - "errorResult" - ] - }, - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "euiccUpdateResult": { - "description": "contains the result of a parameter update in the euicc master data table", - "type": "string", - "enum": [ - "ok", - "badParamFormat", - "badParam" - ] - } - }, - { - "euiccDataResult": { - "description": "contains the result of an ipaEuiccDataRequest request (see also GSMA SGP.32, section 2.11.1.2)", - "type": "object", - "properties": { - "edrResult": { - "description": "status code of the execution of the ipaEuiccDataRequest", - "type": "string", - "enum": [ - "ok", - "incorrectTagList", - "euiccCiPKIdNotFound", - "undefinedError" - ] - }, - "euiccData": { - "description": "contains the resulting eUICC data objects", - "type": "object", - "properties": { - "defaultSmdpAddress": { - "description": "see GSMA SGP.32", - "type": "string" - }, - "euiccInfo1": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "euiccInfo2": { - "description": "ASN.1 encoded, see GSMA SGP.22 and GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "rootSmdsAddress": { - "description": "see GSMA SGP.32", - "type": "string" - }, - "associationToken": { - "description": "see GSMA SGP.32", - "type": "integer" - }, - "eumCertificate": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "euiccCertificate": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "ipaCapabilities": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "deviceInfo": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "notificationsList": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - } - }, - "required": [ - "edrResult" - ] - } - } - }, - { - "procedureError": { - "description": "indicates a problem that lead to a termination of a procedure", - "type": "string", - "enum": [ - "initiateAuthenticationError", - "authenticateResponseError", - "authenticateClientError", - "downloadResponseError", - "getBoundProfilePackageError", - "cancelSessionResponseError", - "handleNotificationError", - "euiccSignatureInvalid", - "undefinedError", - "badPsmo", - "badEco", - "badEdr", - "badOrder", - "abortedOrder", - "stuckOrder", - "noshowOrder" - ] - } - } - ] - } - }, - "debuginfo": { - "description": "Erlang ETS encoded debug information string, for debugging/diagnosis only", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "status" - ] + "$id": "https://onomondo.com/schemas/response", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API response", + "type": "object", + "properties": { + "status": { + "description": "general processing status of the order", + "type": "string", + "enum": [ + "new", + "work", + "done", + "deleted", + "absent" + ] + }, + "timestamp": { + "description": "unix-timestamp of the last status update", + "type": "string" + }, + "resource": { + "$ref": "/schemas/resource" + }, + "outcome": { + "description": "specific result if the executed order", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "enableResult": { + "description": "profile enable PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInDisabledState", + "undefinedError" + ] + } + }, + { + "disableResult": { + "description": "profile disable PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInEnabledState", + "undefinedError" + ] + } + }, + { + "deleteResult": { + "description": "profile delete PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInDisabledState", + "undefinedError" + ] + } + }, + { + "listProfileInfoResult": { + "description": "listProfileInfoResult PSMO result, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "successResult", + "errorResult" + ] + }, + "profileInfoList": { + "description": "contains a list of installed profiles and their meta data, see also RSPDefinitions.asn1", + "type": "array", + "items": { + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "isdpAid": { + "description": "AID of the ISDP (identifies a profile)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "profileState": { + "description": "usage state of the prifle", + "type": "string", + "enum": [ + "disabled", + "enabled" + ] + }, + "profileNickname": { + "description": "human readable nickname name of the profile", + "type": "string" + }, + "serviceProviderName": { + "description": "human readable name of the related service provider", + "type": "string" + }, + "profileName": { + "description": "human readable name of the profile", + "type": "string" + }, + "iconType": { + "description": "graphics format in which the profile icon is supplied", + "type": "string" + }, + "icon": { + "description": "icon graphic", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "profileClass": { + "description": "0=test, 1=provisioning, 2=operational", + "type": "integer" + } + } + } + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "getRATResult": { + "description": "getRAT (rules authorization table) PSMO result, see also RSPDefinitions.asn1", + "type": "array", + "items": { + "type": "object", + "properties": { + "pprUpdateControl": { + "description": "defines how to update PPRs via ES6", + "type": "boolean" + }, + "ppr1": { + "description": "Indicator for PPR1 'Disabling of this Profile is not allowed'", + "type": "boolean" + }, + "ppr2": { + "description": "Indicator for PPR2 'Deletion of this Profile is not allowed'", + "type": "boolean" + }, + "allowedOperators": { + "description": "list of allowed operaters, see also GSMA SGP.22, section 2.9.2.1", + "type": "array", + "items": { + "mccMnc": { + "description": "MCC and MNC coded as defined in 3GPP TS 24.008", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "gid1": { + "description": "referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "gid2": { + "description": "referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "mccMnc" + ] + } + }, + "consentRequired": { + "description": "indicates that the End User consent is required", + "type": "boolean" + }, + "required": [ + "pprUpdateControl", + "ppr1", + "ppr2", + "allowedOperators", + "consentRequired" + ] + } + } + } + }, + { + "configureImmediateEnableResult": { + "description": "configureImmediateEnableResult (automatic profile enabeling) PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "insufficientMemory", + "commandError", + "undefinedError" + ] + } + }, + { + "addEimResult": { + "description": "addEimResult eCO result", + "type": "object", + "properties": { + "addEimResultCode": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "ok", + "insufficientMemory", + "ciPKUnknown", + "invalidAssociationToken", + "counterValueOutOfRange", + "commandError", + "undefinedError", + "malformedResult" + ] + }, + "associationToken": { + "description": "resulting association token, see also GSMA SGP.32, section 2.11.1.1.1", + "type": "integer" + }, + "required": [ + "addEimResultCode" + ] + } + } + }, + { + "deleteEimResult": { + "description": "deleteEimResult eCO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "eimNotFound", + "lastEimDeleted", + "commandError", + "undefinedError" + ] + } + }, + { + "updateEimResult": { + "description": "updateEimResult eCO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "eimNotFound", + "ciPKUnknown", + "counterValueOutOfRange", + "commandError", + "undefinedError" + ] + } + }, + { + "listEimResult": { + "description": "listEimResult eCO result, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "successResult", + "errorResult" + ] + }, + "eimIdList": { + "description": "list containing the IDs of all configured eIM servers", + "type": "array", + "items": { + "eimId": { + "description": "eIM ID", + "type": "string" + }, + "eimIdType": { + "description": "specifies the type of the eIM ID", + "type": "string", + "enum": [ + "eimIdTypeOid", + "eimIdTypeFqdn", + "eimIdTypeProprietary" + ] + }, + "required": [ + "eimId" + ] + } + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "rollbackResult": { + "description": "Status code of the execution of a profile rollback maneuver, see also GSMA SGP.32, section 2.11.1.13 and SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "undefinedError" + ] + } + }, + { + "processingTerminated": { + "description": "Error code in case the eUICC has terminated the overall eUICC package execution, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "resultSizeOverflow", + "unknownOrDamagedCommand", + "interruption", + "undefinedError" + ] + } + }, + { + "notificationResult": { + "description": "Status code to indicate that an otherSignedNotification has been received", + "type": "string", + "enum": [ + "otherSignedNotification" + ] + } + }, + { + "cancelSessionResult": { + "description": "Status code to indicate that the session has been canceled", + "type": "string", + "enum": [ + "ok", + "undefinedError" + ] + } + }, + { + "profileInstallationResult": { + "description": "Final result of a profile download, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about succes or failure", + "enum": [ + "successResult", + "errorResult" + ] + }, + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "euiccUpdateResult": { + "description": "contains the result of a parameter update in the euicc master data table", + "type": "string", + "enum": [ + "ok", + "badParamFormat", + "badParam" + ] + } + }, + { + "euiccDataResult": { + "description": "contains the result of an ipaEuiccDataRequest request (see also GSMA SGP.32, section 2.11.1.2)", + "type": "object", + "properties": { + "edrResult": { + "description": "status code of the execution of the ipaEuiccDataRequest", + "type": "string", + "enum": [ + "ok", + "incorrectTagList", + "euiccCiPKIdNotFound", + "undefinedError" + ] + }, + "euiccData": { + "description": "contains the resulting eUICC data objects", + "type": "object", + "properties": { + "defaultSmdpAddress": { + "description": "see GSMA SGP.32", + "type": "string" + }, + "euiccInfo1": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "euiccInfo2": { + "description": "ASN.1 encoded, see GSMA SGP.22 and GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "rootSmdsAddress": { + "description": "see GSMA SGP.32", + "type": "string" + }, + "associationToken": { + "description": "see GSMA SGP.32", + "type": "integer" + }, + "eumCertificate": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "euiccCertificate": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "ipaCapabilities": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "deviceInfo": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "notificationsList": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + } + }, + "required": [ + "edrResult" + ] + } + } + }, + { + "procedureError": { + "description": "indicates a problem that lead to a termination of a procedure", + "type": "string", + "enum": [ + "initiateAuthenticationError", + "authenticateResponseError", + "authenticateClientError", + "downloadResponseError", + "getBoundProfilePackageError", + "cancelSessionResponseError", + "handleNotificationError", + "euiccSignatureInvalid", + "undefinedError", + "badPsmo", + "badEco", + "badEdr", + "badOrder", + "abortedOrder", + "stuckOrder", + "noshowOrder" + ] + } + } + ] + } + }, + "debuginfo": { + "description": "Erlang ETS encoded debug information string, for debugging/diagnosis only", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "status" + ] + } } - } } -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42879?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I2361891875a8e190fff7003196c2df76fd877080 Gerrit-Change-Number: 42879 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XS] Change in onomondo-eim[master]: esipa_rest_utils: fix searchCritera.profileClass type conversion
by dexter 24 Jun '26

24 Jun '26

Attention is currently required from: dexter, fixeria, laforge. Hello Jenkins Builder, fixeria, laforge, I'd like you to reexamine a change. Please visit https://gerrit.osmocom.org/c/onomondo-eim/+/42834?usp=email to look at the new patch set (#3). The following approvals got outdated and were removed: Code-Review+1 by fixeria, Code-Review+1 by laforge Change subject: esipa_rest_utils: fix searchCritera.profileClass type conversion ...................................................................... esipa_rest_utils: fix searchCritera.profileClass type conversion We currently use utils:hex_to_integer to convert the ProfileClass, which is supposedly a string, to integer. However, hex_to_inteteger does not exist and when looking into the related JSON schema definition of we see that the profileClass member is already defined as integer. This means that ProfileClass already arrives as integer and can be used as it is. removing the hex_to_integer call solves the problem. Change-Id: I4bd223dbef00be9c800539b8d0dc9a84e3e93b73 Related: SYS#8100 --- M src/esipa_rest_utils.erl 1 file changed, 2 insertions(+), 2 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/34/42834/3 -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42834?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newpatchset Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I4bd223dbef00be9c800539b8d0dc9a84e3e93b73 Gerrit-Change-Number: 42834 Gerrit-PatchSet: 3 Gerrit-Owner: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Attention: dexter <pmaier(a)sysmocom.de>

1 0

[XS] Change in onomondo-eim[master]: es9p_client: section 6.3.2.1, rename euiccCiPKIdToBeused to match SGP...
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42874?usp=email ) Change subject: es9p_client: section 6.3.2.1, rename euiccCiPKIdToBeused to match SGP.32 V.1.2 ...................................................................... es9p_client: section 6.3.2.1, rename euiccCiPKIdToBeused to match SGP.32 V.1.2 Section 6.3.2.1: rename InitiateAuthenticationOkEsipa.euiccCiPKIdToBeused to InitiateAuthenticationOkEsipa.euiccCiPKIdentifierToBeUsed Change-Id: I44c60a2f0d1129093ea67908d2eed167643a4a87 Related: SYS#8100 --- M src/esipa_asn1_handler.erl 1 file changed, 6 insertions(+), 1 deletion(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/74/42874/1 diff --git a/src/esipa_asn1_handler.erl b/src/esipa_asn1_handler.erl index e816ee3..ae9bfa9 100644 --- a/src/esipa_asn1_handler.erl +++ b/src/esipa_asn1_handler.erl @@ -48,7 +48,12 @@ % FIXME). Otherwise we would have to add a ctxParams1 field and populate it with the matchingId and the % deviceInfo. The deviceInfo can be retrieved via an eUICC data request. % (see GSMA SGP.32, section 3.1.2.3). - {initiateAuthenticationOkEsipa, InitAuthOk}; + InitAuthOkEsipa = #{transactionId => maps:get(transactionId, InitAuthOk), + serverSigned1 => maps:get(serverSigned1, InitAuthOk), + serverSignature1 => maps:get(serverSignature1, InitAuthOk), + euiccCiPKIdentifierToBeUsed => maps:get(euiccCiPKIdToBeUsed, InitAuthOk), + serverCertificate => maps:get(serverCertificate, InitAuthOk)}, + {initiateAuthenticationOkEsipa, InitAuthOkEsipa}; {initiateAuthenticationError, InitAuthErr} -> ok = mnesia_db:work_finish( Pid, -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42874?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I44c60a2f0d1129093ea67908d2eed167643a4a87 Gerrit-Change-Number: 42874 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XL] Change in onomondo-eim[master]: asn1/SGP32Definitions: upgrade ASN.1 spec to V.1.2
by dexter 24 Jun '26

24 Jun '26

Attention is currently required from: jolly. dexter has posted comments on this change by dexter. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42869?usp=email ) Change subject: asn1/SGP32Definitions: upgrade ASN.1 spec to V.1.2 ...................................................................... Patch Set 2: (1 comment) Patchset: PS1: The trailing white-spaces are part of the specification -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42869?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: Id4d217296f43846aa39f5dc7076465e2dab72a7c Gerrit-Change-Number: 42869 Gerrit-PatchSet: 2 Gerrit-Owner: dexter <pmaier(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: jolly <andreas(a)eversberg.eu> Gerrit-Attention: jolly <andreas(a)eversberg.eu> Gerrit-Comment-Date: Wed, 24 Jun 2026 09:26:56 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No

1 0

[XS] Change in onomondo-eim[master]: esipa_asn1_codec: add special handling for ProvideEimPackageResultRes...
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42875?usp=email ) Change subject: esipa_asn1_codec: add special handling for ProvideEimPackageResultResponse ...................................................................... esipa_asn1_codec: add special handling for ProvideEimPackageResultResponse In SGP.32 V.1.2 ProvideEimPackageResultResponse is defined as a CHOICE. This means that this struct now also requires special handling. Change-Id: I859a175cc28a18ea9334d9b2cf233294fdc95b76 Related: SYS#8100 --- M src/esipa_asn1_codec.erl 1 file changed, 2 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/75/42875/1 diff --git a/src/esipa_asn1_codec.erl b/src/esipa_asn1_codec.erl index 4102575..23cab53 100644 --- a/src/esipa_asn1_codec.erl +++ b/src/esipa_asn1_codec.erl @@ -28,6 +28,8 @@ 'SGP32Definitions':encode('GetBoundProfilePackageResponseEsipa', EimToIpaChoice); encode_eim_to_ipa({cancelSessionResponseEsipa, EimToIpaChoice}) -> 'SGP32Definitions':encode('CancelSessionResponseEsipa', EimToIpaChoice); +encode_eim_to_ipa({provideEimPackageResultResponse, EimToIpaChoice}) -> + 'SGP32Definitions':encode('ProvideEimPackageResultResponse', EimToIpaChoice); encode_eim_to_ipa(emptyResponse) -> {ok, <<>>}; encode_eim_to_ipa(EimToIpa) -> -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42875?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I859a175cc28a18ea9334d9b2cf233294fdc95b76 Gerrit-Change-Number: 42875 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

[XS] Change in onomondo-eim[master]: esipa_asn1_handler: fix transactionId handling
by dexter 24 Jun '26

24 Jun '26

dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42876?usp=email ) Change subject: esipa_asn1_handler: fix transactionId handling ...................................................................... esipa_asn1_handler: fix transactionId handling The transactionId member is now called eimTransactionId. It is also an optional member. Change-Id: I1340e0c7aed091e8e5a5089ebd6e524512408cf7 Related: SYS#8100 --- M src/esipa_asn1_handler_utils.erl 1 file changed, 4 insertions(+), 4 deletions(-) git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/76/42876/1 diff --git a/src/esipa_asn1_handler_utils.erl b/src/esipa_asn1_handler_utils.erl index 5bf47da..c297638 100644 --- a/src/esipa_asn1_handler_utils.erl +++ b/src/esipa_asn1_handler_utils.erl @@ -14,21 +14,21 @@ EuiccPackageResultDataSigned = maps:get( euiccPackageResultDataSigned, EuiccPackageResultSigned ), - maps:get(transactionId, EuiccPackageResultDataSigned); + maps:get(eimTransactionId, EuiccPackageResultDataSigned, none); {euiccPackageErrorSigned, EuiccPackageErrorSigned} -> EuiccPackageErrorDataSigned = maps:get( euiccPackageErrorDataSigned, EuiccPackageErrorSigned ), - maps:get(transactionId, EuiccPackageErrorDataSigned); + maps:get(eimTransactionId, EuiccPackageErrorDataSigned, none); _ -> none end. process_euiccPackageResult(Pid, EuiccPackageResult, EsipaReq, TransactionId) -> WorkBind = fun(Map) -> - case maps:is_key(transactionId, Map) of + case maps:is_key(eimTransactionId, Map) of true -> - mnesia_db:work_bind(Pid, maps:get(transactionId, Map)); + mnesia_db:work_bind(Pid, maps:get(eimTransactionId, Map)); _ -> ok end -- To view, visit https://gerrit.osmocom.org/c/onomondo-eim/+/42876?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: onomondo-eim Gerrit-Branch: master Gerrit-Change-Id: I1340e0c7aed091e8e5a5089ebd6e524512408cf7 Gerrit-Change-Number: 42876 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier(a)sysmocom.de>

1 0

2026

2025

2024

2023

2022

gerrit-log June 2026