File Formats - Revision history

Fheubach at 14:46, 1 May 2018

2018-05-01T14:46:46Z

Coflynn at 16:46, 25 March 2017

2017-03-25T16:46:40Z

Coflynn: /* Example Scripts */ Add multi-trace example, untested

2016-05-18T17:54:37Z

‎Example Scripts: Add multi-trace example, untested

Coflynn: /* Native File Format */ Needs scripts, but initial documentation done

2016-05-18T15:41:09Z

‎Native File Format: Needs scripts, but initial documentation done

Coflynn at 15:10, 18 May 2016

2016-05-18T15:10:44Z

Coflynn: /* Trace Files */ Start of addition of trace data

2016-05-18T15:09:57Z

‎Trace Files: Start of addition of trace data

Coflynn: /* Project Files */

2016-05-18T14:59:33Z

‎Project Files

Coflynn: Initial information

2016-05-18T14:56:10Z

Initial information

Coflynn: /* Project Files */

2016-05-18T14:48:33Z

‎Project Files

Coflynn: Created page with "=File Formats (Projects and Traces)= This page explains some of the file formats used in the ChipWhisperer Software. ==Project Files== ==Trace Files=="

2016-05-18T14:33:25Z

Created page with "=File Formats (Projects and Traces)= This page explains some of the file formats used in the ChipWhisperer Software. ==Project Files== ==Trace Files=="

New page

=File Formats (Projects and Traces)=

This page explains some of the file formats used in the ChipWhisperer Software.

==Project Files==

==Trace Files==

@@ Line 1: / Line 1: @@
-=File Formats (Projects and Traces)=
+==File Formats (Projects and Traces)==
 This page explains some of the file formats used in the ChipWhisperer Software.
-==Project Files==
+===Project Files===
 Project files are stored as a simple text-file. The most basic file will include information about stored traces, along with some basic project file information.
@@ Line 30: / Line 30: @@
 {{Warningbox|If you perform capture before saving a project file, files will be written to a '''temporary directory'''. In this case your project file will reference this temporary directory. Files may not be automatically moved out of this temporary directory when you save a project, but you can always use the "Consolidate" option to force all data to be moved into the project file directory.}}
-==Trace Files==
+===Trace Files===
 Trace files in the ChipWhisperer software are defined through a configuration file, with the suffix <code>.cfg</code>. Any trace added to the ChipWhisperer project will have a configuration file - this file does not store data, but tells the software where it is stored and what format it is stored in.
@@ Line 71: / Line 71: @@
 Let's now investigate specific options for the "native" file format, along with format information.
-=== Native File Format ===
+==== Native File Format ====
 Specific options for the native file format are:
@@ Line 113: / Line 113: @@
 |}
 Each of these is a [http://Docs.scipy.org/doc/numpy/reference/generated/numpy.array.html NumPy array], where the first element is trace n=0, the second is trace n=1, etc. You can load this file using the NumPy load command.
-= Example Scripts =
+== Example Scripts ==
-== Load Native File Format, modify a value, Save File(s) ==
+=== Load Native File Format, modify a value, Save File(s) ===
-== Native File Format to MATLAB Workspace ==
+=== Native File Format to MATLAB Workspace ===
 The following will convert a single file into a MATLAB workspace:<syntaxhighlight lang="python">
 import scipy.io
@@ Line 190: / Line 190: @@
 </syntaxhighlight>
-== Native File Format to Text Files ==
+=== Native File Format to Text Files ===

@@ Line 28: / Line 28: @@
 Normally, in the same folder that the <code>.cwp</code> file is located will be a folder with the same suffix. For example if you have a file called <code>supersecret_aes_test.cwp</code>, there will be a directory called <code>supersecret_aes_test</code>. This directory will contain the trace data along with additional files generated during analysis. Note it's '''not required''' that all files are located in this directory, as you can reference another  location.
-{{Infobox|If you perform capture before saving a project file, files will be written to a '''temporary directory'''. In this case your project file will reference this temporary directory. Files may not be automatically moved out of this temporary directory when you save a project, but you can always use the "Consolidate" option to force all data to be moved into the project file directory.}}
+{{Warningbox|If you perform capture before saving a project file, files will be written to a '''temporary directory'''. In this case your project file will reference this temporary directory. Files may not be automatically moved out of this temporary directory when you save a project, but you can always use the "Consolidate" option to force all data to be moved into the project file directory.}}
 ==Trace Files==

← Older revision		Revision as of 17:54, 18 May 2016
Line 118:		Line 118:

	== Native File Format to MATLAB Workspace ==		== Native File Format to MATLAB Workspace ==
		+	The following will convert a single file into a MATLAB workspace:<syntaxhighlight lang="python">
		+	import scipy.io
		+	import numpy as np
		+
		+	def native_to_matlab(prefix):
		+	tracedata = np.load(prefix + '_traces.npy')
		+	textin = np.load(prefix + '_textin.npy')
		+	textout = np.load(prefix + '_textout.npy')
		+	key = np.load(prefix + '_keylist.npy')
		+
		+	scipy.io.savemat('fileout.mat', {
		+	"traces":tracedata,
		+	"textin":textin,
		+	"textout":textout,
		+	"key":key
		+	})
		+
		+	prefix = r'2016.02.24-19.07.03'
		+	#Can point to full directory like:
		+	#prefix = r'C:\Temp\demo\traces_capdir48\knownrand_fixed\knownrand_fixed_P48_data\traces\2016.02.24-19.07.03'
		+
		+	native_to_matlab(prefix)
		+	</syntaxhighlight>This file can be saved in a location where you want the output MATLAB file. You can specify the full directory link if you are not saving the MATLAB file to the same location as the .npy file. This will operate on a single trace-file only, not on an entire set. If you wish to operate on an entire set, you can load all such files and save the output once like this:<syntaxhighlight lang="python">
		+	import scipy.io
		+	import numpy as np
		+
		+	class native_to_matlab(object):
		+
		+	def __init__(self):
		+	self.tracedata = None
		+	self.textin = None
		+	self.textout = None
		+	self.key = None
		+
		+	def add_trace(self, prefix):
		+	_tracedata = np.load(prefix + '_traces.npy')
		+	_textin = np.load(prefix + '_textin.npy')
		+	_textout = np.load(prefix + '_textout.npy')
		+	_key = np.load(prefix + '_keylist.npy')
		+
		+	if self.tracedata is None:
		+	self.tracedata = _tracedata
		+	self.textin = _textin
		+	self.textout = _textout
		+	self.key = _key
		+
		+	else:
		+	self.tracedata.append(_tracedata)
		+	self.textin.append(_textin)
		+	self.textout.append(_textout)
		+	self.key.append(_key)
		+
		+	def write_matlab(self, fname):
		+	scipy.io.savemat(fname, {
		+	"traces":self.tracedata,
		+	"textin":self.textin,
		+	"textout":self.textout,
		+	"key":self.key
		+	})
		+
		+	n2m = native_to_matlab()
		+
		+	prefix_list = [r'2016.02.24-19.07.03'
		+	#Can point to full directory like:
		+	root_dir = r'C:\Temp\demo\traces_capdir48\knownrand_fixed\knownrand_fixed_P48_data\traces\'
		+
		+	for prefix in prefix_list:
		+	n2m.add_trace(root_dir + prefix)
		+
		+	n2m.write_matlab('fileout.mat')
		+	</syntaxhighlight>

	== Native File Format to Text Files ==		== Native File Format to Text Files ==

@@ Line 73: / Line 73: @@
 === Native File Format ===
 = Example Scripts =
 == Native File Format to MATLAB Workspace ==
 == Native File Format to Text Files ==

← Older revision		Revision as of 15:10, 18 May 2016
Line 72:		Line 72:

	=== Native File Format ===		=== Native File Format ===
		+
		+
		+	= Example Scripts =
		+
		+	== Native File Format to MATLAB Workspace ==
		+
		+	== Native File Format to Text Files ==

@@ Line 7: / Line 7: @@
 Project files are stored as a simple text-file. The most basic file will include information about stored traces, along with some basic project file information.
-As an example, the following shows a simple project file named "test_cw305_artix100_10k_4seg.cwp":<syntaxhighlight>
+As an example, the following shows a simple project file named "test_cw305_artix100_10k_4seg.cwp":<syntaxhighlight lang="cfg">
 [Trace Management]
 tracefile0 = test_cw305_artix100_10k_4seg_data\traces\config_2016.05.15-18.21.25_.cfg
@@ Line 26: / Line 26: @@
 </syntaxhighlight>The most important files are the ones contained in the <code>[Trace Management]</code> section. These contain links to the trace data stored in the project. The specific link is to a configuration file, which is described below.
-Normally, in the same folder that the <code>.cwp</code> file is located will be a folder with the same suffix. For example if you have a file called <code>supersecret_aes_test.cwp</code>, there will be a directory called <code>supersecret_aes_test</code>. This directory will contain the trace data along with additional files generated during analysis. Note it's '''not required''' that all files are located in this directory, as you can reference another location.
+Normally, in the same folder that the <code>.cwp</code> file is located will be a folder with the same suffix. For example if you have a file called <code>supersecret_aes_test.cwp</code>, there will be a directory called <code>supersecret_aes_test</code>. This directory will contain the trace data along with additional files generated during analysis. Note it's '''not required''' that all files are located in this directory, as you can reference another  location.
 {{Infobox|If you perform capture before saving a project file, files will be written to a '''temporary directory'''. In this case your project file will reference this temporary directory. Files may not be automatically moved out of this temporary directory when you save a project, but you can always use the "Consolidate" option to force all data to be moved into the project file directory.}}
@@ Line 33: / Line 33: @@
 Trace files in the ChipWhisperer software are defined through a configuration file, with the suffix <code>.cfg</code>. Any trace added to the ChipWhisperer project will have a configuration file - this file does not store data, but tells the software where it is stored and what format it is stored in.
-While ChipWhisperer has a "native" file format, you can also interface to existing files. We'll first look at the configuration file before exploring the
+While ChipWhisperer has a "native" file format, you can also interface to existing files. We'll first look at the configuration file before exploring the various trace file formats supported.

← Older revision		Revision as of 14:48, 18 May 2016
Line 5:		Line 5:
	==Project Files==		==Project Files==

		+	Project files are stored as a simple text-file. The most basic file will include information about stored traces, along with some basic project file information.

		+	As an example, the following shows a simple project file named "test_cw305_artix100_10k_4seg.cwp":

	==Trace Files==		==Trace Files==