Allow "NotOnChip" for missing DGs of nPA

- changes DG13 into BirthName, DG19 into eAT ResidencePermit1 and DG20
  into eAT ResidencePermit2

- better reading of datasetfile (empty lines are allowed, new line
  character is trimmed from value

- Closes #30 #33 #31

virtualsmartcard/npa-example-data/Example_Dataset_Mueller_Gertrud.txt

@@ -1,22 +1,39 @@
-# This is an example dataset file vor the virtual smartcard.
+# This is an example dataset file for the virtual smartcard.
 # Datagroups are just given in plain ascii, separated by =.
 # CommunityID has to be given as hex values enclosed with ' '.
 # The File is passed to the virtual smartcard emulator via
 # command line option -d, with or without path.
 #
+# Identifier '<NotOnChip>' as parameter value will trigger R-APDU "ERR_FILENOTFOUND" (0x6A82)
+# which indicates in eID service "Attribute not on chip"
+# since first versions of nPA / eAT did not have those data groups
+# example: BirthName=<NotOnChip>
+# This is applicable for ReligiousArtisticName, Nationality, BirthName, ResidencePermit1
+# It may be used for other data groups as well, but makes no sence there
+#
+# Notice: Leading and trailing spaces in value (after equal sign) are part of value string!!!!
+#
+
+# DocumentType "ID" will be nPA, "AR" (and other) will be eAT
 DocumentType=ID
 IssuingState=D
 DateOfExpiry=20201031
-GivenNames = Gertrud
+GivenNames=Gertrud
 FamilyNames=Mueller
 ReligiousArtisticName=ǏǐǑǒǓǔǞǟǤǥǦǧǨǩǪǫǬǭǮǯǰǴǵǺǻǼǽǾǿȘșȚțȞȟȪȫȮȯȰ
 AcademicTitle=
 DateOfBirth=19530304
-PlaceOfBirth= BERLIN FRIEDENAU
+PlaceOfBirth=BERLIN FRIEDENAU
 Nationality=DE
 Sex=F
+BirthName=Schultze
+# helper switch "PlaceOfResidence=<NotOnChip>" can be used to bypass Country, City, ZIP and Street block
 Country=D
 City=BREMEN
 ZIP=28195
-Street =STADTMUSIKANTENWEG 12a
+Street=STADTMUSIKANTENWEG 12a
 CommunityID='\x02\x76\x03\x02\x54\x00\x21'
+
+# ResidencePermit1 and ResidencePermit2 are part of eAT only
+ResidencePermit1=Nebenbestimmungen I Text...(up to 750 characters)
+ResidencePermit2=Nebenbestimmungen II Text.....(up to 250 characters)

virtualsmartcard/src/vpicc/vicc.in

@@ -95,7 +95,7 @@ The data groups in the data set file must have the following syntax: \
 --------------------------------------------------- \
 For Example: GivenNames=GERTRUD. \
 The following Dataset Elements may be used in the dataset file: \
-DocumentType, IssuingState, DateOfExpiry, GivenNames, FamilyNames, ReligiousArtisticName, AcademicTitle, DateOfBirth, PlaceOfBirth, Nationality, Sex, Country, City, ZIP, Street, CommunityID, dg12, dg13, dg14, dg15, dg16, dg19, dg20, dg21.\
+DocumentType, IssuingState, DateOfExpiry, GivenNames, FamilyNames, ReligiousArtisticName, AcademicTitle, DateOfBirth, PlaceOfBirth, Nationality, Sex, BirthName, Country, City, ZIP, Street, CommunityID, ResidencePermit1, ResidencePermit2, dg12, dg14, dg15, dg16, dg21.\
 ")
 
 

virtualsmartcard/src/vpicc/virtualsmartcard/CardGenerator.py

@@ -169,8 +169,9 @@ class CardGenerator(object):
         eid=DF(parent=self.mf, fid=0xffff, dfname='\xe8\x07\x04\x00\x7f\x00\x07\x03\x02')
         eid.extra_fci_data = '\xab\x75\x84\x01\xa4\xaf\x70\xa0\x10\xb4\x06\x95\x01\x20\x83\x01\x04\xb4\x06\x95\x01\x20\x83\x01\x06\xa0\x54\xa4\x14\x95\x01\x80\x7f\x4c\x0e\x06\x09\x04\x00\x7f\x00\x07\x03\x01\x02\x01\x53\x01\x00\xaf\x22\xa4\x18\x95\x01\x80\x7f\x4c\x12\x06\x09\x04\x00\x7f\x00\x07\x03\x01\x02\x02\x53\x05\x00\x00\x00\x00\x00\xa4\x06\x95\x01\x80\x83\x01\x47\xa4\x18\x95\x01\x80\x7f\x4c\x12\x06\x09\x04\x00\x7f\x00\x07\x03\x01\x02\x02\x53\x05\x00\x00\x00\x00\x10\x7a\x06\x8a\x01\x05\x9e\x01\x03'
         # FIXME access control for eid application
+
         DocumentType = self.datagroups["DocumentType"] if "DocumentType" in self.datagroups else 'ID'
-        IssuingState = self.datagroups["IssuingState"] if "IssuingState" in self.datagroups else 'DE'
+        IssuingState = self.datagroups["IssuingState"] if "IssuingState" in self.datagroups else 'D'
         DateOfExpiry = self.datagroups["DateOfExpiry"] if "DateOfExpiry" in self.datagroups else '20201031'
         GivenNames = self.datagroups["GivenNames"] if "GivenNames" in self.datagroups else 'ERIKA'
         FamilyNames = self.datagroups["FamilyNames"] if "FamilyNames" in self.datagroups else 'MUSTERMANN'
@@ -180,58 +181,160 @@ class CardGenerator(object):
         PlaceOfBirth = self.datagroups["PlaceOfBirth"] if "PlaceOfBirth" in self.datagroups else 'BERLIN'
         Nationality = self.datagroups["Nationality"] if "Nationality" in self.datagroups else 'DE'
         Sex = self.datagroups["Sex"] if "Sex" in self.datagroups else 'F'
+        BirthName = self.datagroups["BirthName"] if "BirthName" in self.datagroups else 'Mein Geburtsname'
+        # PlaceOfResidence variable is only a helper to get a switch for <NotOnChip>
+        PlaceOfResidence = self.datagroups["PlaceOfResidence"] if "PlaceOfResidence" in self.datagroups else ''
         Country = self.datagroups["Country"] if "Country" in self.datagroups else 'D'
         City = self.datagroups["City"] if "City" in self.datagroups else 'KOLN'
         ZIP = self.datagroups["ZIP"] if "ZIP" in self.datagroups else '51147'
         Street = self.datagroups["Street"] if "Street" in self.datagroups else 'HEIDESTRASSE 17'
-        CommunityID = eval(self.datagroups["CommunityID"])  if "CommunityID" in self.datagroups else '\x12\x34\x56\x78\x90\x12\x34'
+        CommunityID = eval(self.datagroups["CommunityID"]) if "CommunityID" in self.datagroups else '\x02\x76\x03\x78\x90\x02\x76'
-        dg1 =  pack([(0x61, 0, [(0x13, 0, DocumentType)])], True)
+        # ResidencePermit1 and ResidencePermit2 are part of eAT only
-        dg2 =  pack([(0x62, 0, [(0x13, 0, IssuingState)])], True)
+        ResidencePermit1 = self.datagroups["ResidencePermit1"] if "ResidencePermit1" in self.datagroups else 'ResidencePermit1 field up to 750 characters'
-        dg3 =  pack([(0x63, 0, [(0x12, 0, DateOfExpiry)])], True)
+        ResidencePermit2 = self.datagroups["ResidencePermit2"] if "ResidencePermit2" in self.datagroups else 'ResidencePermit1 field up to 250 characters'
-        dg4 =  pack([(0x64, 0, [(0x0C, 0, GivenNames)])], True)
+
-        dg5 =  pack([(0x65, 0, [(0x0C, 0, FamilyNames)])], True)
+        # Currently, those data groups are for further usage:
-        dg6 =  pack([(0x66, 0, [(0x0C, 0, ReligiousArtisticName)])], True)
+        dg12_param = self.datagroups["dg12"] if "dg12" in self.datagroups else ''
-        dg7 =  pack([(0x67, 0, [(0x0C, 0, AcademicTitle)])], True)
+        dg14_param = self.datagroups["dg14"] if "dg14" in self.datagroups else ''
-        dg8 =  pack([(0x68, 0, [(0x12, 0, DateOfBirth)])], True)
+        dg15_param = self.datagroups["dg15"] if "dg15" in self.datagroups else ''
-        dg9 =  pack([(0x69, 0, [(0xA1, 0, [(0x0C, 0, PlaceOfBirth)])])], True)
+        dg16_param = self.datagroups["dg16"] if "dg16" in self.datagroups else ''
-        dg10 = pack([(0x6A, 0, [(0x13, 0, Nationality)])], True)
+        dg21_param = self.datagroups["dg21"] if "dg21" in self.datagroups else ''
-        dg11 = pack([(0x6B, 0, [(0x13, 0, Sex)])], True)
+
-        dg12 = self.datagroups["dg12"] if "dg12" in self.datagroups else ''
+	# "Attribute not on Chip" makes sence only for ReligiousArtisticName, Nationality, BirthName, ResidencePermit1 and ResidencePermit2, refer to BSI TR-03127
-        dg13 = self.datagroups["dg13"] if "dg13" in self.datagroups else ''
+        if (DocumentType.rstrip() != "<NotOnChip>"):
-        dg14 = self.datagroups["dg14"] if "dg14" in self.datagroups else ''
+	        dg1 =  pack([(0x61, 0, [(0x13, 0, DocumentType)])], True)
-        dg15 = self.datagroups["dg15"] if "dg15" in self.datagroups else ''
+        else:
-        dg16 = self.datagroups["dg16"] if "dg16" in self.datagroups else ''
+	        dg1 = None
-        dg17 = pack([(0x71, 0, [(0x30, 0, [
+        if (IssuingState.rstrip() != "<NotOnChip>"):
-                (0xAA, 0, [(0x0C, 0, Street)]),
+		dg2 =  pack([(0x62, 0, [(0x13, 0, IssuingState)])], True)
-                (0xAB, 0, [(0x0C, 0, City)]),
+        else:
-                (0xAD, 0, [(0x13, 0, Country)]),
+		dg2 = None
-                (0xAE, 0, [(0x13, 0, ZIP)])
+        if (DateOfExpiry.rstrip() != "<NotOnChip>"):
-                ])])], True)
+		dg3 =  pack([(0x63, 0, [(0x12, 0, DateOfExpiry)])], True)
-        dg18 = pack([(0x72, 0, [(0x04, 0, CommunityID)])], True)
+        else:
-        dg19 = self.datagroups["dg19"] if "dg19" in self.datagroups else ''
+		dg3 = None
-        dg20 = self.datagroups["dg20"] if "dg20" in self.datagroups else ''
+        if (GivenNames.rstrip() != "<NotOnChip>"):
-        dg21 = self.datagroups["dg21"] if "dg21" in self.datagroups else ''
+		dg4 =  pack([(0x64, 0, [(0x0C, 0, GivenNames)])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0101, shortfid=0x01, data=dg1))
+        else:
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0102, shortfid=0x02, data=dg2))
+		dg4 = None
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0103, shortfid=0x03, data=dg3))
+        if (FamilyNames.rstrip() != "<NotOnChip>"):
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0104, shortfid=0x04, data=dg4))
+		dg5 =  pack([(0x65, 0, [(0x0C, 0, FamilyNames)])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0105, shortfid=0x05, data=dg5))
+        else:
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0106, shortfid=0x06, data=dg6))
+		dg5 = None
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0107, shortfid=0x07, data=dg7))
+        if (ReligiousArtisticName.rstrip() != "<NotOnChip>"):
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0108, shortfid=0x08, data=dg8))
+		dg6 =  pack([(0x66, 0, [(0x0C, 0, ReligiousArtisticName)])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0109, shortfid=0x09, data=dg9))
+        else:
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010a, shortfid=0x0a, data=dg10))
+		dg6 = None
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010b, shortfid=0x0b, data=dg11))
+        if (AcademicTitle.rstrip() != "<NotOnChip>"):
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010c, shortfid=0x0c, data=dg12))
+		dg7 =  pack([(0x67, 0, [(0x0C, 0, AcademicTitle)])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010d, shortfid=0x0d, data=dg13))
+        else:
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010e, shortfid=0x0e, data=dg14))
+		dg7 = None
-        eid.append(TransparentStructureEF(parent=eid, fid=0x010f, shortfid=0x0f, data=dg15))
+        if (DateOfBirth.rstrip() != "<NotOnChip>"):
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0110, shortfid=0x10, data=dg16))
+		dg8 =  pack([(0x68, 0, [(0x12, 0, DateOfBirth)])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0111, shortfid=0x11, data=dg17))
+        else:
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0112, shortfid=0x12, data=dg18))
+		dg8 = None
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0113, shortfid=0x13, data=dg19))
+        if (PlaceOfBirth.rstrip() != "<NotOnChip>"):
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0114, shortfid=0x14, data=dg20))
+		dg9 =  pack([(0x69, 0, [(0xA1, 0, [(0x0C, 0, PlaceOfBirth)])])], True)
-        eid.append(TransparentStructureEF(parent=eid, fid=0x0115, shortfid=0x15, data=dg21))
+        else:
+		dg9 = None
+        if (Nationality.rstrip() != "<NotOnChip>"):
+		dg10 = pack([(0x6A, 0, [(0x13, 0, Nationality)])], True)
+        else:
+		dg10 = None
+        if (Sex.rstrip() != "<NotOnChip>"):
+		dg11 = pack([(0x6B, 0, [(0x13, 0, Sex)])], True)
+        else:
+		dg11 = None
+        if (dg12_param.rstrip() != "<NotOnChip>"):
+		dg12 = dg12_param
+        else:
+		dg12 = None
+        if (BirthName.rstrip() != "<NotOnChip>"):
+		dg13 = pack([(0x6D, 0, [(0x0C, 0, BirthName)])], True)
+        else:
+		dg13 = None
+        if (dg14_param.rstrip() != "<NotOnChip>"):
+		dg14 = dg14_param
+        else:
+		dg14 = None
+        if (dg15_param.rstrip() != "<NotOnChip>"):
+		dg15 = dg15_param
+        else:
+		dg15 = None
+        if (dg16_param.rstrip() != "<NotOnChip>"):
+		dg16 = dg16_param
+        else:
+		dg16 = None
+        if (PlaceOfResidence.rstrip() != "<NotOnChip>"):
+		dg17 = pack([(0x71, 0, [(0x30, 0, [
+					(0xAA, 0, [(0x0C, 0, Street)]),
+					(0xAB, 0, [(0x0C, 0, City)]),
+					(0xAD, 0, [(0x13, 0, Country)]),
+					(0xAE, 0, [(0x13, 0, ZIP)])
+					])])], True)
+        else:
+		dg17 = None
+	#FIXME: Dataset file with CommunityID =<NotOnChip> still not works while assigning of non hex value due to eval()
+        if (CommunityID.rstrip() != "<NotOnChip>"):
+		dg18 = pack([(0x72, 0, [(0x04, 0, CommunityID)])], True)
+        else:
+		dg18 = None
+        if (ResidencePermit1.rstrip() != "<NotOnChip>"):
+		dg19 = pack([(0x73, 0, [(0xA1, 0, [(0x0C, 0, ResidencePermit1)])])], True)
+        else:
+		dg19 = None
+        if (ResidencePermit1.rstrip() != "<NotOnChip>"):
+		dg20 = pack([(0x74, 0, [(0xA1, 0, [(0x0C, 0, ResidencePermit2)])])], True)
+        else:
+		dg20 = None
+        if (dg21_param.rstrip() != "<NotOnChip>"):
+		dg21 = dg21_param
+        else:
+		dg21 = None
+
+	# If eid.append is not done for a DG, it results into required SwError() with FileNotFound "6A82" APDU return code
+        if dg1:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0101, shortfid=0x01, data=dg1))
+        if dg2:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0102, shortfid=0x02, data=dg2))
+        if dg3:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0103, shortfid=0x03, data=dg3))
+        if dg4:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0104, shortfid=0x04, data=dg4))
+        if dg5:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0105, shortfid=0x05, data=dg5))
+        if dg6:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0106, shortfid=0x06, data=dg6))
+        if dg7:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0107, shortfid=0x07, data=dg7))
+        if dg8:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0108, shortfid=0x08, data=dg8))
+        if dg9:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0109, shortfid=0x09, data=dg9))
+        if dg10:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010a, shortfid=0x0a, data=dg10))
+        if dg11:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010b, shortfid=0x0b, data=dg11))
+        if dg12:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010c, shortfid=0x0c, data=dg12))
+        if dg13:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010d, shortfid=0x0d, data=dg13))
+        if dg14:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010e, shortfid=0x0e, data=dg14))
+        if dg15:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x010f, shortfid=0x0f, data=dg15))
+        if dg16:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0110, shortfid=0x10, data=dg16))
+        if dg17:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0111, shortfid=0x11, data=dg17))
+        if dg18:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0112, shortfid=0x12, data=dg18))
+        if dg19:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0113, shortfid=0x13, data=dg19))
+        if dg20:
+        	eid.append(TransparentStructureEF(parent=eid, fid=0x0114, shortfid=0x14, data=dg20))
+        if dg21:
+		eid.append(TransparentStructureEF(parent=eid, fid=0x0115, shortfid=0x15, data=dg21))
         self.mf.append(eid)
 
         self.sam = nPA_SAM(pin="111111", can="222222", mrz="IDD<<T220001293<<<<<<<<<<<<<<<6408125<2010315D<<<<<<<<<<<<<<MUSTERMANN<<ERIKA<<<<<<<<<<<<<", puk="3333333333", mf=self.mf)
@@ -317,11 +420,12 @@ class CardGenerator(object):
         """Read Datagroups from file"""
         with open(datasetfile, 'r') as f:
 		for line in f:
-			if not line.startswith("#"):
+			if (not line.startswith("#")) and (not len(line.strip()) == 0):
+				# spaces after equal sign are allowed to get strings with leading spaces!
 				line=line.replace(" =", "=")
-				line=line.replace("= ", "=")
 				splitLine = line.split("=")
-				self.datagroups[splitLine[0]] = splitLine[1]
+				# we don't want to have the newline char from dataset file as part of the value!!
+				self.datagroups[splitLine[0]] = splitLine[1].rstrip("\n\r")
 	f.close()
                           
 if __name__ == "__main__":