update .gitignore

.gitignore

@@ -21,3 +21,4 @@ default-data-dir/
 *.d
 *.lst
 *.npy
+README.md

doc/sphinx/conf.py

@@ -24,11 +24,11 @@
 sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/analyzer/attacks'))
 sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/analyzer/attacks/models'))
 sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/analyzer/preprocessing'))
-sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/capture'))
-sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/capture/auxiliary'))
-sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/capture/scopes'))
-sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/capture/targets'))
-sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/capture/utils'))
+sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/api'))
+sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/api/auxiliary'))
+sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/api/scopes'))
+sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/api/targets'))
+sys.path.insert(0, os.path.abspath('../../software/chipwhisperer/api/utils'))
 
 # -- General configuration -----------------------------------------------------
 

doc/sphinx/tutorialbasictimingpasswd.rst

@@ -222,6 +222,24 @@ via the API. This isn't normally exposed, but we can explore that using the Pyth
 2. Now we need to understand how to force this to be called. This can be done via the *Auxiliary Modules*, which we used
    in the previous part to toggle an IO line. Instead we will define one through the command prompt, before finally using
    it in a custom script.
+
+   At the console, type the following to import some require modules (ignore the >>> which just indicate the console prompt)::
+
+    >>> from time import sleep
+    >>> from chipwhisperer.capture.auxiliary.template import AuxiliaryTemplate
+
+3. We will now define a simple
+   in the previous part to toggle an IO line. Instead we will define one through the command prompt, before finally using
+   it in a custom script.
+
+   At the console, type the following to import some require modules (ignore the >>> which just indicate the console prompt)::
+
+    >>> from time import sleep
+    >>> from chipwhisperer.capture.auxiliary.template import AuxiliaryTemplate
+
+3. We will now define a simple
+   in the previous part to toggle an IO line. Instead we will define one through the command prompt, before finally using
+   it in a custom script.
 
    At the console, type the following to import some require modules (ignore the >>> which just indicate the console prompt)::
    

doc/uml/cw_classdiagram.pyns

@@ -0,0 +1,61 @@
+# PynSource Version 1.1
+{'type':'meta', 'info1':'Lorem ipsum dolor sit amet, consectetur adipiscing elit is latin.'}
+{'type':'umlshape', 'id':'AttackObserver', 'x':1059, 'y':5, 'width':203, 'height':124, 'attrs':'_analysisSource', 'meths':'__init__|setAnalysisSource|processAnalysis|_highlightedKey'}
+{'type':'umlshape', 'id':'AnalysisObserver', 'x':1068, 'y':171, 'width':195, 'height':88, 'attrs':'', 'meths':'setAnalysisSource|analysisStarted|analysisUpdated'}
+{'type':'umlshape', 'id':'AnalysisSource', 'x':506, 'y':10, 'width':128, 'height':111, 'attrs':'sigAnalysisStarted|sigAnalysisUpdated|sigAnalysisDone', 'meths':'__init__'}
+{'type':'umlshape', 'id':'Parameterized', 'x':304, 'y':12, 'width':142, 'height':267, 'attrs':'name|description|newName|paramListUpdated|__activeParams|params', 'meths':'__init__|paramList|getName|getDescription|setupActiveParams|addActiveParams|guiActions|getAllActiveParameters|setupGuiActions|lazy'}
+{'type':'umlshape', 'id':'ActiveTraceObserver', 'x':290, 'y':494, 'width':170, 'height':62, 'attrs':'', 'meths':'_setTraceSource'}
+{'type':'umlshape', 'id':'LiveTraceSource', 'x':2, 'y':566, 'width':136, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'PassiveTraceObserver', 'x':286, 'y':320, 'width':178, 'height':150, 'attrs':'_traceSource', 'meths':'__init__|setTraceSource|_setTraceSource|traceSource|processTraces|traceSourcesChanged'}
+{'type':'umlshape', 'id':'TraceSource', 'x':79, 'y':301, 'width':172, 'height':189, 'attrs':'registeredObjects|sigRegisteredObjectsChanged|sigTracesChanged', 'meths':'__init__|getTrace|numPoints|numTraces|offset|deregister|registerAs'}
+{'type':'umlshape', 'id':'ResultsBase', 'x':799, 'y':77, 'width':172, 'height':137, 'attrs':'registeredObjects|sigRegisteredObjectsChanged', 'meths':'__init__|getWidget|deregister|registerAs'}
+{'type':'umlshape', 'id':'ResultsWidgetBase', 'x':589, 'y':214, 'width':153, 'height':62, 'attrs':'', 'meths':'getWidget'}
+{'type':'umlshape', 'id':'AttackResultPlot', 'x':823, 'y':546, 'width':144, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'GraphWidget', 'x':714, 'y':471, 'width':102, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'CorrelationVsTrace', 'x':790, 'y':636, 'width':161, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'AttackSettings', 'x':771, 'y':296, 'width':119, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'OutputVsTime', 'x':960, 'y':636, 'width':111, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'PGEVsTrace', 'x':683, 'y':636, 'width':94, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'ResultsSave', 'x':899, 'y':296, 'width':102, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'ResultsTable', 'x':830, 'y':411, 'width':111, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'WaveFormWidget', 'x':601, 'y':546, 'width':128, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'UserScriptBase', 'x':36, 'y':38, 'width':128, 'height':75, 'attrs':'', 'meths':'__init__|run'}
+{'type':'umlshape', 'id':'PreprocessingBase', 'x':254, 'y':626, 'width':153, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'AttackBaseClass', 'x':502, 'y':471, 'width':136, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'TraceManager', 'x':150, 'y':566, 'width':111, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'ScopeTemplate', 'x':11, 'y':211, 'width':119, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'Plugin', 'x':205, 'y':31, 'width':60, 'height':29, 'attrs':'', 'meths':''}
+{'type':'umlshape', 'id':'TargetTemplate', 'x':6, 'y':141, 'width':128, 'height':29, 'attrs':'', 'meths':''}
+{'type':'edge', 'id':'ScopeTemplate_to_Parameterized', 'source':'ScopeTemplate', 'target':'Parameterized', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'TraceManager_to_TraceSource', 'source':'TraceManager', 'target':'TraceSource', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'LiveTraceSource_to_ScopeTemplate', 'source':'LiveTraceSource', 'target':'ScopeTemplate', 'uml_edge_type':'composition'}
+{'type':'edge', 'id':'AttackObserver_to_AnalysisObserver', 'source':'AttackObserver', 'target':'AnalysisObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'UserScriptBase_to_Parameterized', 'source':'UserScriptBase', 'target':'Parameterized', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AnalysisSource_to_AnalysisObserver', 'source':'AnalysisSource', 'target':'AnalysisObserver', 'uml_edge_type':'composition'}
+{'type':'edge', 'id':'ActiveTraceObserver_to_PassiveTraceObserver', 'source':'ActiveTraceObserver', 'target':'PassiveTraceObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'LiveTraceSource_to_TraceSource', 'source':'LiveTraceSource', 'target':'TraceSource', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'PassiveTraceObserver_to_Parameterized', 'source':'PassiveTraceObserver', 'target':'Parameterized', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'TraceSource_to_PassiveTraceObserver', 'source':'TraceSource', 'target':'PassiveTraceObserver', 'uml_edge_type':'composition'}
+{'type':'edge', 'id':'ResultsBase_to_Parameterized', 'source':'ResultsBase', 'target':'Parameterized', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'PreprocessingBase_to_TraceSource', 'source':'PreprocessingBase', 'target':'TraceSource', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'PreprocessingBase_to_ActiveTraceObserver', 'source':'PreprocessingBase', 'target':'ActiveTraceObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ResultsWidgetBase_to_ResultsBase', 'source':'ResultsWidgetBase', 'target':'ResultsBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AttackResultPlot_to_GraphWidget', 'source':'AttackResultPlot', 'target':'GraphWidget', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AttackResultPlot_to_ResultsWidgetBase', 'source':'AttackResultPlot', 'target':'ResultsWidgetBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AttackResultPlot_to_AttackObserver', 'source':'AttackResultPlot', 'target':'AttackObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'CorrelationVsTrace_to_AttackResultPlot', 'source':'CorrelationVsTrace', 'target':'AttackResultPlot', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'KnowKeySource_to_ResultsBase', 'source':'AttackSettings', 'target':'ResultsBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'KnowKeySource_to_AttackObserver', 'source':'AttackSettings', 'target':'AttackObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'OutputVsTime_to_AttackResultPlot', 'source':'OutputVsTime', 'target':'AttackResultPlot', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'PGEVsTrace_to_AttackResultPlot', 'source':'PGEVsTrace', 'target':'AttackResultPlot', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ResultsSave_to_ResultsBase', 'source':'ResultsSave', 'target':'ResultsBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ResultsSave_to_AttackObserver', 'source':'ResultsSave', 'target':'AttackObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ResultsTable_to_ResultsWidgetBase', 'source':'ResultsTable', 'target':'ResultsWidgetBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ResultsTable_to_AttackObserver', 'source':'ResultsTable', 'target':'AttackObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'WaveFormWidget_to_GraphWidget', 'source':'WaveFormWidget', 'target':'GraphWidget', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'WaveFormWidget_to_ResultsWidgetBase', 'source':'WaveFormWidget', 'target':'ResultsWidgetBase', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'WaveFormWidget_to_ActiveTraceObserver', 'source':'WaveFormWidget', 'target':'ActiveTraceObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AttackBaseClass_to_PassiveTraceObserver', 'source':'AttackBaseClass', 'target':'PassiveTraceObserver', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'AttackBaseClass_to_AnalysisSource', 'source':'AttackBaseClass', 'target':'AnalysisSource', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'TargetTemplate_to_ Parameterized', 'source':'TargetTemplate', 'target':'Parameterized', 'uml_edge_type':'generalisation'}
+{'type':'edge', 'id':'ScopeTemplate_to_TargetTemplate', 'source':'ScopeTemplate', 'target':'TargetTemplate', 'uml_edge_type':'composition'}

hardware/victims/cw305_artixtarget/fpga/vivado_examples/aes128_verilog/aes128_verilog.srcs/sources_1/new/board.v

@@ -0,0 +1,9 @@
+/* This file defines details of the encryption core in use */
+
+/* The following allows you to use the CW305_TOP as part of a block interface */
+//`define USE_BLOCK_INTERFACE
+`define GOOGLE_VAULT_AES
+
+`define CRYPTO_KEY_WIDTH 128
+`define CRYPTO_TEXT_WIDTH 128
+`define CRYPTO_CIPHER_WIDTH 128

software/CWAnalyzer.pyw

@@ -2,6 +2,7 @@
 import ctypes
 import os
 from chipwhisperer.analyzer.ui.CWAnalyzerGUI import main
+import cProfile
 
 if __name__ == '__main__':
 
@@ -10,4 +11,5 @@ if __name__ == '__main__':
         myappid = u'newaetech.chipwhisperer.analyzer.git'  # arbitrary string
         ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
 
+    # cProfile.run('main()')
     main()

software/CWCapture.pyw

@@ -8,7 +8,7 @@ if __name__ == '__main__':
 
     # Windows work-around
     if os.name == "nt":
-        myappid = u'newaetech.chipwhisperer.capture.git'  # arbitrary string
+        myappid = u'newaetech.chipwhisperer.api.git'  # arbitrary string
         ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
 
     main()