May 2025 - gerrit-log - lists.osmocom.org

[S] Change in osmo-upf[master]: Log regular tunmap/tunend actions as INFO

by laforge

Attention is currently required from: pespin. laforge has posted comments on this change by pespin. ( https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email ) Change subject: Log regular tunmap/tunend actions as INFO ...................................................................... Patch Set 2: Code-Review+1 -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: If24b1247ab21d1bdb7314244a7936d92377a5548 Gerrit-Change-Number: 40234 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Comment-Date: Tue, 06 May 2025 20:18:57 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

4 months

1
0
0 0

[S] Change in osmo-upf[master]: up_session: Log regular Establish/Modify/Release as INFO

by laforge

Attention is currently required from: fixeria, neels, osmith, pespin. laforge has posted comments on this change by pespin. ( https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email ) Change subject: up_session: Log regular Establish/Modify/Release as INFO ...................................................................... Patch Set 2: Code-Review+1 -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ibc1633f316d1d1009893a6e02361b5be190cbce8 Gerrit-Change-Number: 40233 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Attention: osmith <osmith(a)sysmocom.de> Gerrit-Attention: neels <nhofmeyr(a)sysmocom.de> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Comment-Date: Tue, 06 May 2025 20:18:47 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

4 months

1
0
0 0

[M] Change in pysim[master]: docs: Build the pySim.esim library documentation

by laforge

laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/40235?usp=email ) Change subject: docs: Build the pySim.esim library documentation ...................................................................... docs: Build the pySim.esim library documentation ... we added doc-strings but missed to actually render them in the manual so far. Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb --- M docs/index.rst A docs/library-esim.rst 2 files changed, 96 insertions(+), 0 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved diff --git a/docs/index.rst b/docs/index.rst index 3c6d5d7..92be830 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,7 @@ legacy smpp2sim library + library-esim osmo-smdpp sim-rest suci-keytool diff --git a/docs/library-esim.rst b/docs/library-esim.rst new file mode 100644 index 0000000..aae7110 --- /dev/null +++ b/docs/library-esim.rst @@ -0,0 +1,95 @@ +pySim eSIM libraries +==================== + +The pySim eSIM libraries implement a variety of functionality related to the GSMA eSIM universe, +including the various interfaces of SGP.21 + SGP.22, as well as Interoperable Profile decioding, +validation, personalization and encoding. + +.. automodule:: pySim.esim + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - High Level +--------------------------------------------------------- + +pySim.esim.rsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.rsp + :members: + +pySim.esim.es2p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es2p + :members: + + +pySim.esim.es8p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es8p + :members: + + +pySim.esim.es9p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es9p + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - Low Level +-------------------------------------------------------- + +pySim.esim.bsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.bsp + :members: + +pySim.esim.http_json_api +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.http_json_api + :members: + +pySim.esim.x509_cert +~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.x509_cert + :members: + +SIMalliance / TCA Interoperable Profile +--------------------------------------- + + +pySim.esim.saip +~~~~~~~~~~~~~~~ +.. automodule:: pySim.esim.saip + :members: + + +pySim.esim.saip.oid +~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.oid + :members: + +pySim.esim.saip.personalization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.personalization + :members: + +pySim.esim.saip.templates +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.templates + :members: + +pySim.esim.saip.validation +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.validation + :members: -- To view, visit https://gerrit.osmocom.org/c/pysim/+/40235?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb Gerrit-Change-Number: 40235 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org>

4 months

1
0
0 0

[M] Change in pysim[master]: docs: Build the pySim.esim library documentation

by laforge

laforge has posted comments on this change by laforge. ( https://gerrit.osmocom.org/c/pysim/+/40235?usp=email ) Change subject: docs: Build the pySim.esim library documentation ...................................................................... Patch Set 1: Code-Review+2 -- To view, visit https://gerrit.osmocom.org/c/pysim/+/40235?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb Gerrit-Change-Number: 40235 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Comment-Date: Tue, 06 May 2025 20:17:50 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes

4 months

1
0
0 0

[M] Change in pysim[master]: docs: Better python doc-strings for better pySim.esim manual

by laforge

laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/pysim/+/40236?usp=email ) Change subject: docs: Better python doc-strings for better pySim.esim manual ...................................................................... docs: Better python doc-strings for better pySim.esim manual Change-Id: I7be6264c665a2a25105681bb5e72d0f6715bbef8 --- M pySim/esim/__init__.py M pySim/esim/bsp.py M pySim/esim/es8p.py M pySim/esim/rsp.py M pySim/esim/saip/__init__.py M pySim/esim/saip/oid.py M pySim/esim/saip/personalization.py M pySim/esim/saip/templates.py M pySim/esim/saip/validation.py M pySim/esim/x509_cert.py 10 files changed, 88 insertions(+), 50 deletions(-) git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/36/40236/1 diff --git a/pySim/esim/__init__.py b/pySim/esim/__init__.py index 29e2bf4..35b733e 100644 --- a/pySim/esim/__init__.py +++ b/pySim/esim/__init__.py @@ -61,8 +61,8 @@ return asn1tools.compile_string(asn_txt, codec=codec) -# SGP.22 section 4.1 Activation Code class ActivationCode: + """SGP.22 section 4.1 Activation Code""" def __init__(self, hostname:str, token:str, oid: Optional[str] = None, cc_required: Optional[bool] = False): if '$' in hostname: raise ValueError('$ sign not permitted in hostname') @@ -78,6 +78,7 @@ @staticmethod def decode_str(ac: str) -> dict: + """decode an activation code from its string representation.""" if ac[0] != '1': raise ValueError("Unsupported AC_Format '%s'!" % ac[0]) ac_elements = ac.split('$') diff --git a/pySim/esim/bsp.py b/pySim/esim/bsp.py index 862502f..fb4c0b3 100644 --- a/pySim/esim/bsp.py +++ b/pySim/esim/bsp.py @@ -1,11 +1,9 @@ -# Early proof-of-concept implementation of -# GSMA eSIM RSP (Remote SIM Provisioning BSP (BPP Protection Protocol), -# where BPP is the Bound Profile Package. So the full expansion is the -# "GSMA eSIM Remote SIM Provisioning Bound Profile Packate Protection Protocol" -# -# Originally (SGP.22 v2.x) this was called SCP03t, but it has since been -# renamed to BSP. -# +"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning BSP (BPP Protection Protocol), +where BPP is the Bound Profile Package. So the full expansion is the +"GSMA eSIM Remote SIM Provisioning Bound Profile Packate Protection Protocol" + +Originally (SGP.22 v2.x) this was called SCP03t, but it has since been renamed to BSP.""" + # (C) 2023 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify @@ -45,6 +43,7 @@ MAX_SEGMENT_SIZE = 1020 class BspAlgo(abc.ABC): + """Base class representing a cryptographic algorithm within the BSP (BPP Security Protocol).""" blocksize: int def _get_padding(self, in_len: int, multiple: int, padding: int = 0) -> bytes: @@ -62,6 +61,7 @@ return self.__class__.__name__ class BspAlgoCrypt(BspAlgo, abc.ABC): + """Base class representing an encryption/decryption algorithm within the BSP (BPP Security Protocol).""" def __init__(self, s_enc: bytes): self.s_enc = s_enc @@ -93,6 +93,7 @@ """Actual implementation, to be implemented by derived class.""" class BspAlgoCryptAES128(BspAlgoCrypt): + """AES-CBC-128 implementation of the BPP Security Protocol for GSMA SGP.22 eSIM.""" name = 'AES-CBC-128' blocksize = 16 @@ -133,6 +134,7 @@ class BspAlgoMac(BspAlgo, abc.ABC): + """Base class representing a message authentication code algorithm within the BSP (BPP Security Protocol).""" l_mac = 0 # must be overridden by derived class def __init__(self, s_mac: bytes, initial_mac_chaining_value: bytes): @@ -167,6 +169,7 @@ """To be implemented by algorithm specific derived class.""" class BspAlgoMacAES128(BspAlgoMac): + """AES-CMAC-128 implementation of the BPP Security Protocol for GSMA SGP.22 eSIM.""" name = 'AES-CMAC-128' l_mac = 8 diff --git a/pySim/esim/es8p.py b/pySim/esim/es8p.py index dd0c4bc..8bd7e14 100644 --- a/pySim/esim/es8p.py +++ b/pySim/esim/es8p.py @@ -1,6 +1,5 @@ -# Implementation of GSMA eSIM RSP (Remote SIM Provisioning) ES8+ -# as per SGP22 v3.0 Section 5.5 -# +"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning) ES8+ as per SGP22 v3.0 Section 5.5""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify diff --git a/pySim/esim/rsp.py b/pySim/esim/rsp.py index 4b189e1..3dccf2d 100644 --- a/pySim/esim/rsp.py +++ b/pySim/esim/rsp.py @@ -1,6 +1,5 @@ -# Implementation of GSMA eSIM RSP (Remote SIM Provisioning) -# as per SGP22 v3.0 -# +"""Implementation of GSMA eSIM RSP (Remote SIM Provisioning) as per SGP22 v3.0""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify diff --git a/pySim/esim/saip/__init__.py b/pySim/esim/saip/__init__.py index 21f44ef..305a373 100644 --- a/pySim/esim/saip/__init__.py +++ b/pySim/esim/saip/__init__.py @@ -1,5 +1,5 @@ -# Implementation of SimAlliance/TCA Interoperable Profile handling -# +"""Implementation of SimAlliance/TCA Interoperable Profile handling""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify @@ -45,7 +45,7 @@ logger = logging.getLogger(__name__) class Naa: - """A class defining a Network Access Application (NAA).""" + """A class defining a Network Access Application (NAA)""" name = None # AID prefix, as used for ADF and EF.DIR aid = None @@ -61,6 +61,7 @@ return 'adf-' + cls.mandatory_services[0] class NaaCsim(Naa): + """A class representing the CSIM (CDMA) Network Access Application (NAA)""" name = "csim" aid = h2b("") mandatory_services = ["csim"] @@ -68,6 +69,7 @@ templates = [oid.ADF_CSIM_by_default, oid.ADF_CSIMopt_not_by_default] class NaaUsim(Naa): + """A class representing the USIM Network Access Application (NAA)""" name = "usim" aid = h2b("a0000000871002") mandatory_services = ["usim"] @@ -80,6 +82,7 @@ adf = ADF_USIM() class NaaIsim(Naa): + """A class representing the ISIM Network Access Application (NAA)""" name = "isim" aid = h2b("a0000000871004") mandatory_services = ["isim"] @@ -750,6 +753,7 @@ class ProfileElementMF(FsProfileElement): + """Class representing the ProfileElement for the MF (Master File)""" type = 'mf' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -763,6 +767,7 @@ # TODO: resize EF.DIR? class ProfileElementPuk(ProfileElement): + """Class representing the ProfileElement for a PUK (PIN Unblocking Code)""" type = 'pukCodes' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -793,6 +798,7 @@ class ProfileElementPin(ProfileElement): + """Class representing the ProfileElement for a PIN (Personal Identification Number)""" type = 'pinCodes' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -829,6 +835,7 @@ class ProfileElementTelecom(FsProfileElement): + """Class representing the ProfileElement for DF.TELECOM""" type = 'telecom' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -841,6 +848,7 @@ self.decoded[fname] = [] class ProfileElementCD(FsProfileElement): + """Class representing the ProfileElement for DF.CD""" type = 'cd' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -853,6 +861,7 @@ self.decoded[fname] = [] class ProfileElementPhonebook(FsProfileElement): + """Class representing the ProfileElement for DF.PHONEBOOK""" type = 'phonebook' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -865,6 +874,7 @@ self.decoded[fname] = [] class ProfileElementGsmAccess(FsProfileElement): + """Class representing the ProfileElement for ADF.USIM/DF.GSM-ACCESS""" type = 'gsm-access' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -877,6 +887,7 @@ self.decoded[fname] = [] class ProfileElementDf5GS(FsProfileElement): + """Class representing the ProfileElement for ADF.USIM/DF.5GS""" type = 'df-5gs' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -889,6 +900,7 @@ self.decoded[fname] = [] class ProfileElementEAP(FsProfileElement): + """Class representing the ProfileElement for DF.EAP""" type = 'eap' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -901,6 +913,7 @@ self.decoded[fname] = [] class ProfileElementDfSAIP(FsProfileElement): + """Class representing the ProfileElement for DF.SAIP""" type = 'df-saip' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -913,6 +926,7 @@ self.decoded[fname] = [] class ProfileElementDfSNPN(FsProfileElement): + """Class representing the ProfileElement for DF.SNPN""" type = 'df-snpn' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -925,6 +939,7 @@ self.decoded[fname] = [] class ProfileElementDf5GProSe(FsProfileElement): + """Class representing the ProfileElement for DF.5GProSe""" type = 'df-5gprose' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -1218,6 +1233,7 @@ class ProfileElementRFM(ProfileElement): + """Class representing the ProfileElement for RFM (Remote File Management).""" type = 'rfm' def __init__(self, decoded: Optional[dict] = None, @@ -1243,6 +1259,7 @@ } class ProfileElementUSIM(FsProfileElement): + """Class representing the ProfileElement for ADF.USIM Mandatory Files""" type = 'usim' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -1265,6 +1282,7 @@ return dec_imsi(b2h(f.body)) class ProfileElementOptUSIM(FsProfileElement): + """Class representing the ProfileElement for ADF.USIM Optional Files""" type = 'opt-usim' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -1275,6 +1293,7 @@ self.decoded['templateID'] = str(oid.ADF_USIMopt_not_by_default_v2) class ProfileElementISIM(FsProfileElement): + """Class representing the ProfileElement for ADF.ISIM Mandatory Files""" type = 'isim' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -1291,6 +1310,7 @@ return b2h(self.decoded['adf-isim'][0][1]['dfName']) class ProfileElementOptISIM(FsProfileElement): + """Class representing the ProfileElement for ADF.ISIM Optional Files""" type = 'opt-isim' def __init__(self, decoded: Optional[dict] = None, **kwargs): @@ -1302,6 +1322,7 @@ class ProfileElementAKA(ProfileElement): + """Class representing the ProfileElement for Authentication and Key Agreement (AKA).""" type = 'akaParameter' # TODO: RES size for USIM test algorithm can be set to 32, 64 or 128 bits. This value was # previously limited to 128 bits. Recommendation: Avoid using RES size 32 or 64 in Profiles @@ -1381,6 +1402,7 @@ }) class ProfileElementHeader(ProfileElement): + """Class representing the ProfileElement for the Header of the PE-Sequence.""" type = 'header' def __init__(self, decoded: Optional[dict] = None, ver_major: Optional[int] = 2, ver_minor: Optional[int] = 3, @@ -1421,6 +1443,7 @@ raise ValueError("service not in eUICC-Mandatory-services list, cannot remove") class ProfileElementEnd(ProfileElement): + """Class representing the ProfileElement for the End of the PE-Sequence.""" type = 'end' def __init__(self, decoded: Optional[dict] = None, **kwargs): super().__init__(decoded, **kwargs) diff --git a/pySim/esim/saip/oid.py b/pySim/esim/saip/oid.py index 02ef23b..a9c23e2 100644 --- a/pySim/esim/saip/oid.py +++ b/pySim/esim/saip/oid.py @@ -1,5 +1,5 @@ -# Implementation of SimAlliance/TCA Interoperable Profile OIDs -# +"""Implementation of SimAlliance/TCA Interoperable Profile OIDs""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify diff --git a/pySim/esim/saip/personalization.py b/pySim/esim/saip/personalization.py index cd23944..053ea0c 100644 --- a/pySim/esim/saip/personalization.py +++ b/pySim/esim/saip/personalization.py @@ -1,5 +1,5 @@ -# Implementation of SimAlliance/TCA Interoperable Profile handling -# +"""Implementation of Personalization of eSIM profiles in SimAlliance/TCA Interoperable Profile.""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify diff --git a/pySim/esim/saip/templates.py b/pySim/esim/saip/templates.py index 3ec0b9b..393168f 100644 --- a/pySim/esim/saip/templates.py +++ b/pySim/esim/saip/templates.py @@ -1,5 +1,5 @@ -# Implementation of SimAlliance/TCA Interoperable Profile Template handling -# +"""Implementation of SimAlliance/TCA Interoperable Profile Templates.""" + # (C) 2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify @@ -224,8 +224,8 @@ # below are transcribed template definitions from "ANNEX A (Normative): File Structure Templates Definition" # of "Profile interoperability specification V3.3.1 Final" (unless other version explicitly specified). -# Section 9.2 class FilesAtMF(ProfileTemplate): + """Files at MF as per Section 9.2""" created_by_default = True oid = OID.MF files = [ @@ -238,8 +238,9 @@ ] -# Section 9.3 class FilesCD(ProfileTemplate): + """Files at DF.CD as per Section 9.3""" + created_by_default = True created_by_default = False oid = OID.DF_CD files = [ @@ -287,8 +288,8 @@ for i in range(0x98, 0xa0): df_pb_files.append(FileTemplate(0x4f00+i, 'EF.CCP1', 'LF', None, None, 5, None, 'FF...FF', False, ['nb_rec','size','sfi'], ppath=[0x5f3a])) -# Section 9.4 v2.3.1 class FilesTelecom(ProfileTemplate): + """Files at DF.TELECOM as per Section 9.4 v2.3.1""" created_by_default = False oid = OID.DF_TELECOM base_path = Path('MF') @@ -328,8 +329,8 @@ ] -# Section 9.4 class FilesTelecomV2(ProfileTemplate): + """Files at DF.TELECOM as per Section 9.4""" created_by_default = False oid = OID.DF_TELECOM_v2 base_path = Path('MF') @@ -379,8 +380,8 @@ ] -# Section 9.5.1 v2.3.1 class FilesUsimMandatory(ProfileTemplate): + """Mandatory Files at ADF.USIM as per Section 9.5.1 v2.3.1""" created_by_default = True oid = OID.ADF_USIM_by_default files = [ @@ -410,8 +411,8 @@ FileTemplate(0x6fe4, 'EF.EPSNSC', 'LF', 1, 80, 5, 0x18, 'FF...FF', False, ass_serv=[85], high_update=True), ] -# Section 9.5.1 class FilesUsimMandatoryV2(ProfileTemplate): + """Mandatory Files at ADF.USIM as per Section 9.5.1""" created_by_default = True oid = OID.ADF_USIM_by_default_v2 files = [ @@ -442,8 +443,8 @@ ] -# Section 9.5.2 v2.3.1 class FilesUsimOptional(ProfileTemplate): + """Optional Files at ADF.USIM as per Section 9.5.2 v2.3.1""" created_by_default = False optional = True oid = OID.ADF_USIMopt_not_by_default @@ -529,6 +530,7 @@ # Section 9.5.2 class FilesUsimOptionalV2(ProfileTemplate): + """Optional Files at ADF.USIM as per Section 9.5.2""" created_by_default = False optional = True oid = OID.ADF_USIMopt_not_by_default_v2 @@ -622,8 +624,8 @@ FileTemplate(0x6ffd, 'EF.MudMidCfgdata','BT', None, None,2, None, None, True, ['size'], ass_serv=[134]), ] -# Section 9.5.2.3 v3.3.1 class FilesUsimOptionalV3(ProfileTemplate): + """Optional Files at ADF.USIM as per Section 9.5.2.3 v3.3.1""" created_by_default = False optional = True oid = OID.ADF_USIMopt_not_by_default_v3 @@ -633,16 +635,16 @@ FileTemplate(0x6f01, 'EF.eAKA', 'TR', None, 1, 3, None, None, True, ['size'], ass_serv=[134]), ] -# Section 9.5.3 class FilesUsimDfPhonebook(ProfileTemplate): + """DF.PHONEBOOK Files at ADF.USIM as per Section 9.5.3""" created_by_default = False oid = OID.DF_PHONEBOOK_ADF_USIM base_path = Path('ADF.USIM') files = df_pb_files -# Section 9.5.4 class FilesUsimDfGsmAccess(ProfileTemplate): + """DF.GSM-ACCESS Files at ADF.USIM as per Section 9.5.4""" created_by_default = False oid = OID.DF_GSM_ACCESS_ADF_USIM base_path = Path('ADF.USIM') @@ -656,8 +658,8 @@ ] -# Section 9.5.11 v2.3.1 class FilesUsimDf5GS(ProfileTemplate): + """DF.5GS Files at ADF.USIM as per Section 9.5.11 v2.3.1""" created_by_default = False oid = OID.DF_5GS base_path = Path('ADF.USIM') @@ -677,8 +679,8 @@ ] -# Section 9.5.11.2 class FilesUsimDf5GSv2(ProfileTemplate): + """DF.5GS Files at ADF.USIM as per Section 9.5.11.2""" created_by_default = False oid = OID.DF_5GS_v2 base_path = Path('ADF.USIM') @@ -700,8 +702,8 @@ ] -# Section 9.5.11.3 class FilesUsimDf5GSv3(ProfileTemplate): + """DF.5GS Files at ADF.USIM as per Section 9.5.11.3""" created_by_default = False oid = OID.DF_5GS_v3 base_path = Path('ADF.USIM') @@ -724,8 +726,8 @@ FileTemplate(0x4f0c, 'EF.TN3GPPSNN', 'TR', None, 1, 2, 0x0c, '00', False, ass_serv=[135]), ] -# Section 9.5.11.4 class FilesUsimDf5GSv4(ProfileTemplate): + """DF.5GS Files at ADF.USIM as per Section 9.5.11.4""" created_by_default = False oid = OID.DF_5GS_v4 base_path = Path('ADF.USIM') @@ -756,8 +758,8 @@ ] -# Section 9.5.12 class FilesUsimDfSaip(ProfileTemplate): + """DF.SAIP Files at ADF.USIM as per Section 9.5.12""" created_by_default = False oid = OID.DF_SAIP base_path = Path('ADF.USIM') @@ -767,8 +769,8 @@ FileTemplate(0x4f01, 'EF.SUCICalcInfo','TR', None, None, 3, None, 'FF...FF', False, ['size'], ass_serv=[125], pe_name='ef-suci-calc-info-usim'), ] -# Section 9.5.13 class FilesDfSnpn(ProfileTemplate): + """DF.SNPN Files at ADF.USIM as per Section 9.5.13""" created_by_default = False oid = OID.DF_SNPN base_path = Path('ADF.USIM') @@ -778,8 +780,8 @@ FileTemplate(0x4f01, 'EF.PWS_SNPN', 'TR', None, 1, 10, None, None, True, ass_serv=[143]), ] -# Section 9.5.14 class FilesDf5GProSe(ProfileTemplate): + """DF.ProSe Files at ADF.USIM as per Section 9.5.14""" created_by_default = False oid = OID.DF_5GProSe base_path = Path('ADF.USIM') @@ -794,8 +796,8 @@ FileTemplate(0x4f06, 'EF.5G_PROSE_UIR', 'TR', None, 32, 2, 0x06, None, True, ass_serv=[139,1005]), ] -# Section 9.6.1 class FilesIsimMandatory(ProfileTemplate): + """Mandatory Files at ADF.ISIM as per Section 9.6.1""" created_by_default = True oid = OID.ADF_ISIM_by_default files = [ @@ -809,8 +811,8 @@ ] -# Section 9.6.2 v2.3.1 class FilesIsimOptional(ProfileTemplate): + """Optional Files at ADF.ISIM as per Section 9.6.2 of v2.3.1""" created_by_default = False optional = True oid = OID.ADF_ISIMopt_not_by_default @@ -829,8 +831,8 @@ ] -# Section 9.6.2 class FilesIsimOptionalv2(ProfileTemplate): + """Optional Files at ADF.ISIM as per Section 9.6.2""" created_by_default = False optional = True oid = OID.ADF_ISIMopt_not_by_default_v2 @@ -857,8 +859,8 @@ # TODO: CSIM -# Section 9.8 class FilesEap(ProfileTemplate): + """Files at DF.EAP as per Section 9.8""" created_by_default = False oid = OID.DF_EAP files = [ diff --git a/pySim/esim/saip/validation.py b/pySim/esim/saip/validation.py index c253b7a..c115554 100644 --- a/pySim/esim/saip/validation.py +++ b/pySim/esim/saip/validation.py @@ -1,5 +1,5 @@ -# Implementation of SimAlliance/TCA Interoperable Profile handling -# +"""Implementation of SimAlliance/TCA Interoperable Profile validation.""" + # (C) 2023-2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify @@ -19,16 +19,21 @@ from pySim.esim.saip import * class ProfileError(Exception): + """Raised when a ProfileConstraintChecker finds an error in a file [structure].""" pass class ProfileConstraintChecker: + """Base class of a constraint checker for a ProfileElementSequence.""" def check(self, pes: ProfileElementSequence): + """Execute all the check_* methods of the ProfileConstraintChecker against the given + ProfileElementSequence""" for name in dir(self): if name.startswith('check_'): method = getattr(self, name) method(pes) class CheckBasicStructure(ProfileConstraintChecker): + """ProfileConstraintChecker for the basic profile structure constraints.""" def _is_after_if_exists(self, pes: ProfileElementSequence, opt:str, after:str): opt_pe = pes.get_pe_for_type(opt) if opt_pe: @@ -38,6 +43,7 @@ # FIXME: check order def check_start_and_end(self, pes: ProfileElementSequence): + """Check for mandatory header and end ProfileElements at the right position.""" if pes.pe_list[0].type != 'header': raise ProfileError('first element is not header') if pes.pe_list[1].type != 'mf': @@ -47,6 +53,7 @@ raise ProfileError('last element is not end') def check_number_of_occurrence(self, pes: ProfileElementSequence): + """Check The number of occurrence of various ProfileElements.""" # check for invalid number of occurrences if len(pes.get_pes_for_type('header')) != 1: raise ProfileError('multiple ProfileHeader') @@ -60,6 +67,7 @@ raise ProfileError('multiple PE-%s' % tn.upper()) def check_optional_ordering(self, pes: ProfileElementSequence): + """Check the ordering of optional PEs following the respective mandatory ones.""" # ordering and required depenencies self._is_after_if_exists(pes,'opt-usim', 'usim') self._is_after_if_exists(pes,'opt-isim', 'isim') @@ -104,17 +112,21 @@ FileChoiceList = List[Tuple] class FileError(ProfileError): + """Raised when a FileConstraintChecker finds an error in a file [structure].""" pass class FileConstraintChecker: def check(self, l: FileChoiceList): + """Execute all the check_* methods of the FileConstraintChecker against the given FileChoiceList""" for name in dir(self): if name.startswith('check_'): method = getattr(self, name) method(l) class FileCheckBasicStructure(FileConstraintChecker): + """Validator for the basic structure of a decoded file.""" def check_seqence(self, l: FileChoiceList): + """Check the sequence/ordering.""" by_type = {} for k, v in l: if k in by_type: diff --git a/pySim/esim/x509_cert.py b/pySim/esim/x509_cert.py index e951de7..c8a0386 100644 --- a/pySim/esim/x509_cert.py +++ b/pySim/esim/x509_cert.py @@ -1,6 +1,5 @@ -# Implementation of X.509 certificate handling in GSMA eSIM -# as per SGP22 v3.0 -# +"""Implementation of X.509 certificate handling in GSMA eSIM as per SGP22 v3.0""" + # (C) 2024 by Harald Welte <laforge(a)osmocom.org> # # This program is free software: you can redistribute it and/or modify -- To view, visit https://gerrit.osmocom.org/c/pysim/+/40236?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I7be6264c665a2a25105681bb5e72d0f6715bbef8 Gerrit-Change-Number: 40236 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org>

4 months

1
0
0 0

[M] Change in pysim[master]: docs: Build the pySim.esim library documentation

by laforge

laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/pysim/+/40235?usp=email ) Change subject: docs: Build the pySim.esim library documentation ...................................................................... docs: Build the pySim.esim library documentation ... we added doc-strings but missed to actually render them in the manual so far. Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb --- M docs/index.rst A docs/library-esim.rst 2 files changed, 96 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/35/40235/1 diff --git a/docs/index.rst b/docs/index.rst index 3c6d5d7..92be830 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,7 @@ legacy smpp2sim library + library-esim osmo-smdpp sim-rest suci-keytool diff --git a/docs/library-esim.rst b/docs/library-esim.rst new file mode 100644 index 0000000..aae7110 --- /dev/null +++ b/docs/library-esim.rst @@ -0,0 +1,95 @@ +pySim eSIM libraries +==================== + +The pySim eSIM libraries implement a variety of functionality related to the GSMA eSIM universe, +including the various interfaces of SGP.21 + SGP.22, as well as Interoperable Profile decioding, +validation, personalization and encoding. + +.. automodule:: pySim.esim + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - High Level +--------------------------------------------------------- + +pySim.esim.rsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.rsp + :members: + +pySim.esim.es2p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es2p + :members: + + +pySim.esim.es8p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es8p + :members: + + +pySim.esim.es9p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es9p + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - Low Level +-------------------------------------------------------- + +pySim.esim.bsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.bsp + :members: + +pySim.esim.http_json_api +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.http_json_api + :members: + +pySim.esim.x509_cert +~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.x509_cert + :members: + +SIMalliance / TCA Interoperable Profile +--------------------------------------- + + +pySim.esim.saip +~~~~~~~~~~~~~~~ +.. automodule:: pySim.esim.saip + :members: + + +pySim.esim.saip.oid +~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.oid + :members: + +pySim.esim.saip.personalization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.personalization + :members: + +pySim.esim.saip.templates +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.templates + :members: + +pySim.esim.saip.validation +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.validation + :members: -- To view, visit https://gerrit.osmocom.org/c/pysim/+/40235?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb Gerrit-Change-Number: 40235 Gerrit-PatchSet: 1 Gerrit-Owner: laforge <laforge(a)osmocom.org>

4 months

1
0
0 0

[S] Change in osmo-upf[master]: up_session: Log regular Establish/Modify/Release as INFO

by pespin

Attention is currently required from: fixeria, laforge, neels, osmith, pespin. Hello Jenkins Builder, fixeria, laforge, neels, osmith, I'd like you to reexamine a change. Please visit https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email to look at the new patch set (#2). The following approvals got outdated and were removed: Verified-1 by Jenkins Builder Change subject: up_session: Log regular Establish/Modify/Release as INFO ...................................................................... up_session: Log regular Establish/Modify/Release as INFO Change-Id: Ibc1633f316d1d1009893a6e02361b5be190cbce8 --- M src/osmo-upf/up_session.c M tests/unique_ids/unique_ids_test.err 2 files changed, 8 insertions(+), 8 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/33/40233/2 -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newpatchset Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ibc1633f316d1d1009893a6e02361b5be190cbce8 Gerrit-Change-Number: 40233 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de> Gerrit-Reviewer: laforge <laforge(a)osmocom.org> Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de> Gerrit-Reviewer: osmith <osmith(a)sysmocom.de> Gerrit-Attention: osmith <osmith(a)sysmocom.de> Gerrit-Attention: neels <nhofmeyr(a)sysmocom.de> Gerrit-Attention: laforge <laforge(a)osmocom.org> Gerrit-Attention: pespin <pespin(a)sysmocom.de> Gerrit-Attention: fixeria <vyanitskiy(a)sysmocom.de>

4 months

1
0
0 0

[S] Change in osmo-upf[master]: Log regular tunmap/tunend actions as INFO

by pespin

Attention is currently required from: pespin. Hello Jenkins Builder, I'd like you to reexamine a change. Please visit https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email to look at the new patch set (#2). The following approvals got outdated and were removed: Verified-1 by Jenkins Builder Change subject: Log regular tunmap/tunend actions as INFO ...................................................................... Log regular tunmap/tunend actions as INFO Change-Id: If24b1247ab21d1bdb7314244a7936d92377a5548 --- M src/osmo-upf/up_gtp_action.c M tests/unique_ids/unique_ids_test.err 2 files changed, 12 insertions(+), 12 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/34/40234/2 -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newpatchset Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: If24b1247ab21d1bdb7314244a7936d92377a5548 Gerrit-Change-Number: 40234 Gerrit-PatchSet: 2 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Attention: pespin <pespin(a)sysmocom.de>

4 months

1
0
0 0

[XS] Change in osmo-upf[master]: Log regular tunmap/tunend actions as INFO

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email ) Change subject: Log regular tunmap/tunend actions as INFO ...................................................................... Log regular tunmap/tunend actions as INFO Change-Id: If24b1247ab21d1bdb7314244a7936d92377a5548 --- M src/osmo-upf/up_gtp_action.c 1 file changed, 4 insertions(+), 4 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/34/40234/1 diff --git a/src/osmo-upf/up_gtp_action.c b/src/osmo-upf/up_gtp_action.c index a3c6b68..f8b8e58 100644 --- a/src/osmo-upf/up_gtp_action.c +++ b/src/osmo-upf/up_gtp_action.c @@ -85,7 +85,7 @@ switch (a->kind) { case UP_GTP_U_TUNEND: if (g_upf->tunend.mockup) { - LOG_UP_GTP_ACTION(a, LOGL_NOTICE, "tunend/mockup active, skipping GTP action %s\n", + LOG_UP_GTP_ACTION(a, LOGL_INFO, "tunend/mockup active, skipping GTP action %s\n", enable ? "enable" : "disable"); return 0; } @@ -111,13 +111,13 @@ enable ? "enable" : "disable", rc); return rc; } - LOG_UP_GTP_ACTION(a, LOGL_NOTICE, "%s tunend on dev %s\n", enable ? "Enabled" : "Disabled", + LOG_UP_GTP_ACTION(a, LOGL_INFO, "%s tunend on dev %s\n", enable ? "Enabled" : "Disabled", gtp_dev->name); return 0; case UP_GTP_U_TUNMAP: if (g_upf->tunmap.mockup) { - LOG_UP_GTP_ACTION(a, LOGL_NOTICE, "tunmap/mockup active, skipping nftables ruleset %s\n", + LOG_UP_GTP_ACTION(a, LOGL_INFO, "tunmap/mockup active, skipping nftables ruleset %s\n", enable ? "enable" : "disable"); return 0; } @@ -131,7 +131,7 @@ enable ? "enable" : "disable", rc); return rc; } - LOG_UP_GTP_ACTION(a, LOGL_NOTICE, "%s tunmap, nft chain IDs: access--%u-> <-%u--core\n", + LOG_UP_GTP_ACTION(a, LOGL_INFO, "%s tunmap, nft chain IDs: access--%u-> <-%u--core\n", enable ? "Enabled" : "Disabled", a->tunmap.access.chain_id, a->tunmap.core.chain_id); return 0; -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40234?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: If24b1247ab21d1bdb7314244a7936d92377a5548 Gerrit-Change-Number: 40234 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de>

4 months

1
0
0 0

[XS] Change in osmo-upf[master]: up_session: Log regular Establish/Modify/Release as INFO

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email ) Change subject: up_session: Log regular Establish/Modify/Release as INFO ...................................................................... up_session: Log regular Establish/Modify/Release as INFO Change-Id: Ibc1633f316d1d1009893a6e02361b5be190cbce8 --- M src/osmo-upf/up_session.c 1 file changed, 3 insertions(+), 3 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/33/40233/1 diff --git a/src/osmo-upf/up_session.c b/src/osmo-upf/up_session.c index a9bc7c3..b96fd49 100644 --- a/src/osmo-upf/up_session.c +++ b/src/osmo-upf/up_session.c @@ -738,7 +738,7 @@ return; } - LOGPFSML(fi, LOGL_NOTICE, "Session modified: %s\n", up_session_gtp_status(session)); + LOGPFSML(fi, LOGL_INFO, "Session modified: %s\n", up_session_gtp_status(session)); return; nack_response: @@ -789,7 +789,7 @@ static void up_session_established_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) { struct up_session *session = fi->priv; - LOGPFSML(fi, LOGL_NOTICE, "Session established: %s %s\n", up_session_to_str_c(OTC_SELECT, session), + LOGPFSML(fi, LOGL_INFO, "Session established: %s %s\n", up_session_to_str_c(OTC_SELECT, session), up_session_gtp_status(session)); } @@ -820,7 +820,7 @@ { struct up_session *session = fi->priv; struct up_gtp_action *a; - LOGPFSML(fi, LOGL_NOTICE, "Session releasing: %s %s\n", up_session_to_str_c(OTC_SELECT, session), up_session_gtp_status(session)); + LOGPFSML(fi, LOGL_INFO, "Session releasing: %s %s\n", up_session_to_str_c(OTC_SELECT, session), up_session_gtp_status(session)); /* Shut down all active GTP rules */ while ((a = llist_first_entry_or_null(&session->active_gtp_actions, struct up_gtp_action, entry))) { -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/40233?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: newchange Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ibc1633f316d1d1009893a6e02361b5be190cbce8 Gerrit-Change-Number: 40233 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de>

4 months

1
0
0 0

2025

2024

2023

2022

gerrit-log May 2025