From: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
To: dev@dpdk.org
Cc: pablo.de.lara.guarch@intel.com, john.mcnamara@intel.com
Subject: [dpdk-dev] [PATCH v3 9/9] doc: update ipsec sample guide
Date: Thu, 9 Jun 2016 09:42:50 +0100 [thread overview]
Message-ID: <1465461770-42233-10-git-send-email-sergio.gonzalez.monroy@intel.com> (raw)
In-Reply-To: <1465461770-42233-1-git-send-email-sergio.gonzalez.monroy@intel.com>
Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
---
doc/guides/sample_app_ug/img/ipsec_endpoints.svg | 850 +++++++++++++++++++++
doc/guides/sample_app_ug/ipsec_secgw.rst | 910 ++++++++++++++---------
2 files changed, 1400 insertions(+), 360 deletions(-)
create mode 100644 doc/guides/sample_app_ug/img/ipsec_endpoints.svg
diff --git a/doc/guides/sample_app_ug/img/ipsec_endpoints.svg b/doc/guides/sample_app_ug/img/ipsec_endpoints.svg
new file mode 100644
index 0000000..e4aba4c
--- /dev/null
+++ b/doc/guides/sample_app_ug/img/ipsec_endpoints.svg
@@ -0,0 +1,850 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ xmlns:osb="http://www.openswatchbook.org/uri/2009/osb"
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="155.68507mm"
+ height="76.061203mm"
+ viewBox="0 0 551.64003 269.50821"
+ id="svg2"
+ version="1.1"
+ inkscape:version="0.91 r13725"
+ sodipodi:docname="endpoints.svg">
+ <defs
+ id="defs4">
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker18451"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path18453"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker18273"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ inkscape:connector-curvature="0"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path18275" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker10612"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow2Send">
+ <path
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ style="fill:#cfce37;fill-opacity:1;fill-rule:evenodd;stroke:#cfce37;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ id="path10614"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker10270"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lstart">
+ <path
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path10272"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Sstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker9102"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path9104"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#035002;fill-opacity:1;fill-rule:evenodd;stroke:#035002;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.2,0,0,0.2,1.2,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Sstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Sstart"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path5945"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#d4ce00;fill-opacity:1;fill-rule:evenodd;stroke:#d4ce00;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.2,0,0,0.2,1.2,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <linearGradient
+ id="linearGradient11398"
+ osb:paint="gradient">
+ <stop
+ style="stop-color:#000000;stop-opacity:1;"
+ offset="0"
+ id="stop11400" />
+ <stop
+ style="stop-color:#000000;stop-opacity:0;"
+ offset="1"
+ id="stop11402" />
+ </linearGradient>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker9540"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path9542"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <linearGradient
+ id="linearGradient9336"
+ osb:paint="solid">
+ <stop
+ style="stop-color:#dc181a;stop-opacity:1;"
+ offset="0"
+ id="stop9338" />
+ </linearGradient>
+ <marker
+ inkscape:stockid="Arrow1Lstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker7350"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path7352"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lstart"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path4871"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker7092"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path7094"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5822"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path5824"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker5369"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path5371"
+ style="fill:#035002;fill-opacity:1;fill-rule:evenodd;stroke:#035002;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="TriangleOutL"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="TriangleOutL"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path5013"
+ d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="scale(0.8,0.8)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Tail"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Tail"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <g
+ id="g4907"
+ transform="scale(-1.2,-1.2)"
+ style="fill:#528ac6;fill-opacity:1;stroke:#000000;stroke-opacity:1">
+ <path
+ id="path4909"
+ d="M -3.8048674,-3.9585227 0.54352094,0"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ <path
+ id="path4911"
+ d="M -1.2866832,-3.9585227 3.0617053,0"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ <path
+ id="path4913"
+ d="M 1.3053582,-3.9585227 5.6537466,0"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ <path
+ id="path4915"
+ d="M -3.8048674,4.1775838 0.54352094,0.21974226"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ <path
+ id="path4917"
+ d="M -1.2866832,4.1775838 3.0617053,0.21974226"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ <path
+ id="path4919"
+ d="M 1.3053582,4.1775838 5.6537466,0.21974226"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ </g>
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow2Send"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path4904"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Send"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path4886"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#528ac6;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(-0.2,0,0,-0.2,-1.2,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lend"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path4874"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5734-4"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path5736-7"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5734-4-3"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path5736-7-7"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:isstock="true"
+ style="overflow:visible"
+ id="marker5734-4-4"
+ refX="0"
+ refY="0"
+ orient="auto"
+ inkscape:stockid="Arrow1Lend">
+ <path
+ transform="matrix(-0.8,0,0,-0.8,-10,0)"
+ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ id="path5736-7-1"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker5369-3"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path5371-1"
+ style="fill:#d4ce00;fill-opacity:1;fill-rule:evenodd;stroke:#d4ce00;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker5369-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path5371-9"
+ style="fill:#38782d;fill-opacity:1;fill-rule:evenodd;stroke:#38782d;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow2Send"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker5369-3-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path5371-1-0"
+ style="fill:#38782d;fill-opacity:1;fill-rule:evenodd;stroke:#38782d;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+ d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+ transform="matrix(-0.3,0,0,-0.3,0.69,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lend"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker18451-7"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ inkscape:connector-curvature="0"
+ id="path18453-7"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(-0.8,0,0,-0.8,-10,0)" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="Arrow1Lstart-7"
+ style="overflow:visible"
+ inkscape:isstock="true"
+ inkscape:collect="always">
+ <path
+ id="path4871-0"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ <marker
+ inkscape:stockid="Arrow1Lstart"
+ orient="auto"
+ refY="0"
+ refX="0"
+ id="marker7350-9"
+ style="overflow:visible"
+ inkscape:isstock="true">
+ <path
+ id="path7352-0"
+ d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+ transform="matrix(0.8,0,0,0.8,10,0)"
+ inkscape:connector-curvature="0" />
+ </marker>
+ </defs>
+ <sodipodi:namedview
+ id="base"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:pageopacity="0.0"
+ inkscape:pageshadow="2"
+ inkscape:zoom="2.8"
+ inkscape:cx="258.01346"
+ inkscape:cy="122.99559"
+ inkscape:document-units="cm"
+ inkscape:current-layer="layer1"
+ showgrid="false"
+ inkscape:window-width="1920"
+ inkscape:window-height="1017"
+ inkscape:window-x="1592"
+ inkscape:window-y="-8"
+ inkscape:window-maximized="1"
+ fit-margin-top="3"
+ fit-margin-right="1"
+ fit-margin-bottom="1"
+ fit-margin-left="1" />
+ <metadata
+ id="metadata7">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ <dc:title></dc:title>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(194.35761,4.2637303)">
+ <rect
+ style="opacity:1;fill:#528ac6;fill-opacity:1;stroke:none;stroke-opacity:1"
+ id="rect4140-5"
+ width="131.15564"
+ height="102.30846"
+ x="-179.57692"
+ y="140.22072"
+ ry="7.155364" />
+ <rect
+ style="opacity:1;fill:#528ac6;fill-opacity:1;stroke:none;stroke-opacity:1"
+ id="rect4140-5-1"
+ width="131.15564"
+ height="102.30846"
+ x="213.55591"
+ y="140.22072"
+ ry="6.5590839" />
+ <rect
+ style="opacity:1;fill:#528ac6;fill-opacity:1;stroke:none;stroke-opacity:1"
+ id="rect4140-5-2"
+ width="131.15564"
+ height="46.258114"
+ x="-179.57692"
+ y="6.3661909"
+ ry="5.3665228" />
+ <rect
+ style="opacity:1;fill:#528ac6;fill-opacity:1;stroke:none;stroke-opacity:1"
+ id="rect4140-5-2-7"
+ width="131.15564"
+ height="46.258114"
+ x="213.55591"
+ y="6.3661909"
+ ry="6.5590839" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-182.36929"
+ y="188.59424"
+ id="text4210"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan4212"
+ x="-182.36929"
+ y="188.59424">ep0</tspan><tspan
+ sodipodi:role="line"
+ x="-182.36929"
+ y="208.69011"
+ id="tspan4214" /><tspan
+ sodipodi:role="line"
+ x="-182.36929"
+ y="228.786"
+ id="tspan4216" /></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="324.621"
+ y="188.49612"
+ id="text4218"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan4220"
+ x="324.621"
+ y="188.49612">ep1</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-159.97678"
+ y="32.860863"
+ id="text4222"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan4224"
+ x="-159.97678"
+ y="32.860863">traffic gen</tspan><tspan
+ sodipodi:role="line"
+ x="-159.97678"
+ y="52.956738"
+ id="tspan4226" /></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="249.77068"
+ y="32.860863"
+ id="text4222-1"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan4224-1"
+ x="249.77068"
+ y="32.860863">traffic gen</tspan><tspan
+ sodipodi:role="line"
+ x="249.77068"
+ y="52.956738"
+ id="tspan4226-6" /></text>
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#Arrow1Lend)"
+ d="m -48.997848,184.52811 c 260.957198,-0.5963 260.957198,-0.5963 260.957198,-0.5963"
+ id="path5305"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#marker10270)"
+ d="M -47.641399,212.81116 C 213.3158,212.21487 213.3158,212.21487 213.3158,212.21487"
+ id="path5305-2"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#marker7350)"
+ d="m 262.8239,53.615939 c 0,85.864371 0,85.864371 0,85.864371"
+ id="path5922-0-6"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Lstart)"
+ d="m -146.8568,54.80849 c 0,85.86437 0,85.86437 0,85.86437"
+ id="path5922-0-1"
+ inkscape:connector-curvature="0" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:12.5px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="246.78571"
+ y="500.57648"
+ id="text7750"
+ sodipodi:linespacing="125%"><tspan
+ sodipodi:role="line"
+ id="tspan7752"
+ x="246.78571"
+ y="500.57648" /></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-158.9595"
+ y="151.84753"
+ id="text7754"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7756"
+ x="-158.9595"
+ y="151.84753">2</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-110.66317"
+ y="151.84753"
+ id="text7758"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7760"
+ x="-110.66317"
+ y="151.84753">3</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="267.07309"
+ y="151.84753"
+ id="text7762"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7764"
+ x="267.07309"
+ y="151.84753">2</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="318.81448"
+ y="151.84753"
+ id="text7766"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7768"
+ x="318.81448"
+ y="151.84753">3</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="225.86406"
+ y="183.73483"
+ id="text7770"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7772"
+ x="225.86406"
+ y="183.73483">0</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="226.18214"
+ y="211.56969"
+ id="text7774"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7776"
+ x="226.18214"
+ y="211.56969">1</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:11.25px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="311.78571"
+ y="505.93362"
+ id="text7778"
+ sodipodi:linespacing="125%"><tspan
+ sodipodi:role="line"
+ id="tspan7780"
+ x="311.78571"
+ y="505.93362" /></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-65.239075"
+ y="183.73483"
+ id="text7782"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7784"
+ x="-65.239075"
+ y="183.73483">0</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-weight:normal;font-size:18.08628845px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="-64.921005"
+ y="211.56969"
+ id="text7786"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7788"
+ x="-64.921005"
+ y="211.56969">1</tspan></text>
+ <path
+ style="fill:none;fill-rule:evenodd;stroke:#dc181a;stroke-width:1.60606241;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:3.21212486, 9.63637456;stroke-dashoffset:0;stroke-opacity:1"
+ d="M -190.00162,248.33118 C -74.638406,174.62535 10.240093,56.871479 81.499676,57.515772 176.72224,59.019701 245.16177,197.27679 352.92565,246.54234"
+ id="path7850"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="ccc" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#dc181a;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="84.985992"
+ y="98.449951"
+ id="text7876"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7878"
+ x="84.985992"
+ y="98.449951">UNPROTECTED</tspan><tspan
+ sodipodi:role="line"
+ x="84.985992"
+ y="118.54583"
+ id="tspan7886">cipher-text</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:center;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:middle;fill:#dc181a;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="84.899643"
+ y="20.937273"
+ id="text7880"
+ sodipodi:linespacing="125%"
+ inkscape:transform-center-x="48.100163"
+ inkscape:transform-center-y="3.577681"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan7882"
+ x="84.899643"
+ y="20.937273">PROTECTED</tspan><tspan
+ sodipodi:role="line"
+ x="84.899643"
+ y="41.03315"
+ id="tspan7884">clear-text</tspan></text>
+ <path
+ style="fill:none;fill-opacity:1;fill-rule:evenodd;stroke:#035002;stroke-width:3.42781782;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker5369)"
+ d="m -101.57521,164.71986 c -0.0232,13.22578 17.528492,19.5572 32.486212,20.12768"
+ id="path9370"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;fill-rule:evenodd;stroke:#d4ce00;stroke-width:3.08351111;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker5369-3)"
+ d="m 231.46374,184.56991 c 19.27508,-1.72507 24.47287,-7.77038 31.06883,-19.63365"
+ id="path9370-8"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.8206749px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="60.45417"
+ y="251.78688"
+ id="text14635"
+ sodipodi:linespacing="125%"
+ transform="scale(0.9630889,1.0383257)"><tspan
+ sodipodi:role="line"
+ id="tspan14637"
+ x="60.45417"
+ y="251.78688">outbound</tspan></text>
+ <text
+ xml:space="preserve"
+ style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:16.07670021px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:'sans-serif, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+ x="62.073208"
+ y="232.23116"
+ id="text14635-4"
+ sodipodi:linespacing="125%"
+ transform="scale(0.96291595,1.0385122)"><tspan
+ sodipodi:role="line"
+ id="tspan14637-2"
+ x="62.073208"
+ y="232.23116">inbound</tspan></text>
+ <path
+ style="fill:none;fill-rule:evenodd;stroke:#d4ce00;stroke-width:3.8278625;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-start:url(#Arrow1Sstart)"
+ d="m -144.07995,171.20523 c 15.90052,30.60035 40.80354,39.04445 75.670299,43.29761"
+ id="path9370-1"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;fill-opacity:1;fill-rule:evenodd;stroke:#035002;stroke-width:3.73783302;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-start:url(#marker9102)"
+ d="m 236.99654,212.30897 c 40.08586,-4.29157 62.39356,-19.33069 76.11102,-48.84339"
+ id="path9370-8-8"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;fill-rule:evenodd;stroke:#d4ce00;stroke-width:4.01917505;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 32.274837,235.80819 c 18.037567,-0.2236 20.456397,-0.29813 20.456397,-0.29813"
+ id="path10604"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:none;fill-rule:evenodd;stroke:#035002;stroke-width:4.01917505;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+ d="m 32.274837,256.82674 c 18.037567,-0.22362 20.456397,-0.29814 20.456397,-0.29814"
+ id="path10604-4"
+ inkscape:connector-curvature="0"
+ sodipodi:nodetypes="cc" />
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Lstart-7)"
+ d="m -100.78618,138.21108 c 0,-85.864363 0,-85.864363 0,-85.864363"
+ id="path5922-0-1-5"
+ inkscape:connector-curvature="0" />
+ <path
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.60767007px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#marker7350-9)"
+ d="m 312.42811,137.49681 c 0,-85.864382 0,-85.864382 0,-85.864382"
+ id="path5922-0-6-9"
+ inkscape:connector-curvature="0" />
+ </g>
+</svg>
diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst
index c11c7e7..66dd326 100644
--- a/doc/guides/sample_app_ug/ipsec_secgw.rst
+++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
@@ -38,165 +38,171 @@ Overview
--------
The application demonstrates the implementation of a Security Gateway
-(not IPsec compliant, see Constraints bellow) using DPDK based on RFC4301,
+(not IPsec compliant, see the Constraints section below) using DPDK based on RFC4301,
RFC4303, RFC3602 and RFC2404.
Internet Key Exchange (IKE) is not implemented, so only manual setting of
Security Policies and Security Associations is supported.
The Security Policies (SP) are implemented as ACL rules, the Security
-Associations (SA) are stored in a table and the Routing is implemented
+Associations (SA) are stored in a table and the routing is implemented
using LPM.
-The application classify the ports between Protected and Unprotected.
-Thus, traffic received in an Unprotected or Protected port is consider
+The application classifies the ports as *Protected* and *Unprotected*.
+Thus, traffic received on an Unprotected or Protected port is consider
Inbound or Outbound respectively.
-Path for IPsec Inbound traffic:
+The Path for IPsec Inbound traffic is:
-* Read packets from the port
+* Read packets from the port.
* Classify packets between IPv4 and ESP.
-* Inbound SA lookup for ESP packets based on their SPI
-* Verification/Decryption
-* Removal of ESP and outer IP header
-* Inbound SP check using ACL of decrypted packets and any other IPv4 packet
- we read.
-* Routing
-* Write packet to port
-
-Path for IPsec Outbound traffic:
-
-* Read packets from the port
-* Outbound SP check using ACL of all IPv4 traffic
-* Outbound SA lookup for packets that need IPsec protection
-* Add ESP and outer IP header
-* Encryption/Digest
-* Routing
-* Write packet to port
+* Perform Inbound SA lookup for ESP packets based on their SPI.
+* Perform Verification/Decryption.
+* Remove ESP and outer IP header
+* Inbound SP check using ACL of decrypted packets and any other IPv4 packets.
+* Routing.
+* Write packet to port.
+
+The Path for the IPsec Outbound traffic is:
+
+* Read packets from the port.
+* Perform Outbound SP check using ACL of all IPv4 traffic.
+* Perform Outbound SA lookup for packets that need IPsec protection.
+* Add ESP and outer IP header.
+* Perform Encryption/Digest.
+* Routing.
+* Write packet to port.
+
Constraints
-----------
-* IPv4 traffic
-* ESP tunnel mode
-* EAS-CBC, HMAC-SHA1 and NULL
-* Each SA must be handle by a unique lcore (1 RX queue per port)
-* No chained mbufs
+
+* No IPv6 options headers.
+* No AH mode.
+* Currently only EAS-CBC, HMAC-SHA1 and NULL.
+* Each SA must be handle by a unique lcore (*1 RX queue per port*).
+* No chained mbufs.
+
Compiling the Application
-------------------------
To compile the application:
-#. Go to the sample application directory:
-
- .. code-block:: console
+#. Go to the sample application directory::
export RTE_SDK=/path/to/rte_sdk
cd ${RTE_SDK}/examples/ipsec-secgw
-#. Set the target (a default target is used if not specified). For example:
+#. Set the target (a default target is used if not specified). For example::
- .. code-block:: console
export RTE_TARGET=x86_64-native-linuxapp-gcc
See the *DPDK Getting Started Guide* for possible RTE_TARGET values.
-#. Build the application:
-
- .. code-block:: console
+#. Build the application::
make
+#. [Optional] Build the application for debugging:
+ This option adds some extra flags, disables compiler optimizations and
+ is verbose::
+
+ make DEBUG=1
+
+
Running the Application
-----------------------
-The application has a number of command line options:
+The application has a number of command line options::
-.. code-block:: console
- ./build/ipsec-secgw [EAL options] -- -p PORTMASK -P -u PORTMASK --config
- (port,queue,lcore)[,(port,queue,lcore] --single-sa SAIDX --ep0|--ep1
+ ./build/ipsec-secgw [EAL options] --
+ -p PORTMASK -P -u PORTMASK
+ --config (port,queue,lcore)[,(port,queue,lcore]
+ --single-sa SAIDX
+ --ep0|--ep1
-where,
+Where:
-* -p PORTMASK: Hexadecimal bitmask of ports to configure
+* ``-p PORTMASK``: Hexadecimal bitmask of ports to configure.
-* -P: optional, sets all ports to promiscuous mode so that packets are
+* ``-P``: *optional*. Sets all ports to promiscuous mode so that packets are
accepted regardless of the packet's Ethernet MAC destination address.
Without this option, only packets with the Ethernet MAC destination address
set to the Ethernet address of the port are accepted (default is enabled).
-* -u PORTMASK: hexadecimal bitmask of unprotected ports
+* ``-u PORTMASK``: hexadecimal bitmask of unprotected ports
-* --config (port,queue,lcore)[,(port,queue,lcore)]: determines which queues
- from which ports are mapped to which cores
+* ``--config (port,queue,lcore)[,(port,queue,lcore)]``: determines which queues
+ from which ports are mapped to which cores.
-* --single-sa SAIDX: use a single SA for outbound traffic, bypassing the SP
+* ``--single-sa SAIDX``: use a single SA for outbound traffic, bypassing the SP
on both Inbound and Outbound. This option is meant for debugging/performance
purposes.
-* --ep0: configure the app as Endpoint 0.
+* ``--ep0``: configure the app as Endpoint 0.
-* --ep1: configure the app as Endpoint 1.
+* ``--ep1``: configure the app as Endpoint 1.
-Either one of --ep0 or --ep1 *must* be specified.
-The main purpose of these options is two easily configure two systems
-back-to-back that would forward traffic through an IPsec tunnel.
+Either one of ``--ep0`` or ``--ep1`` **must** be specified.
+The main purpose of these options is to easily configure two systems
+back-to-back that would forward traffic through an IPsec tunnel (see
+:ref:`figure_ipsec_endpoints`).
The mapping of lcores to port/queues is similar to other l3fwd applications.
-For example, given the following command line:
+For example, given the following command line::
-.. code-block:: console
-
- ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048
- --vdev "cryptodev_null_pmd" -- -p 0xf -P -u 0x3
- --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" --ep0
+ ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
+ --vdev "cryptodev_null_pmd" -- -p 0xf -P -u 0x3 \
+ --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" --ep0 \
where each options means:
-* The -l option enables cores 20 and 21
+* The ``-l`` option enables cores 20 and 21.
-* The -n option sets memory 4 channels
+* The ``-n`` option sets memory 4 channels.
-* The --socket-mem to use 2GB on socket 1
+* The ``--socket-mem`` to use 2GB on socket 1.
-* The --vdev "cryptodev_null_pmd" option creates virtual NULL cryptodev PMD
+* The ``--vdev "cryptodev_null_pmd"`` option creates virtual NULL cryptodev PMD.
-* The -p option enables ports (detected) 0, 1, 2 and 3
+* The ``-p`` option enables ports (detected) 0, 1, 2 and 3.
-* The -P option enables promiscuous mode
+* The ``-P`` option enables promiscuous mode.
-* The -u option sets ports 1 and 2 as unprotected, leaving 2 and 3 as protected
+* The ``-u`` option sets ports 1 and 2 as unprotected, leaving 2 and 3 as protected.
-* The --config option enables one queue per port with the following mapping:
+* The ``--config`` option enables one queue per port with the following mapping:
-+----------+-----------+-----------+---------------------------------------+
-| **Port** | **Queue** | **lcore** | **Description** |
-| | | | |
-+----------+-----------+-----------+---------------------------------------+
-| 0 | 0 | 20 | Map queue 0 from port 0 to lcore 20. |
-| | | | |
-+----------+-----------+-----------+---------------------------------------+
-| 1 | 0 | 20 | Map queue 0 from port 1 to lcore 20. |
-| | | | |
-+----------+-----------+-----------+---------------------------------------+
-| 2 | 0 | 21 | Map queue 0 from port 2 to lcore 21. |
-| | | | |
-+----------+-----------+-----------+---------------------------------------+
-| 3 | 0 | 21 | Map queue 0 from port 3 to lcore 21. |
-| | | | |
-+----------+-----------+-----------+---------------------------------------+
+ +----------+-----------+-----------+---------------------------------------+
+ | **Port** | **Queue** | **lcore** | **Description** |
+ | | | | |
+ +----------+-----------+-----------+---------------------------------------+
+ | 0 | 0 | 20 | Map queue 0 from port 0 to lcore 20. |
+ | | | | |
+ +----------+-----------+-----------+---------------------------------------+
+ | 1 | 0 | 20 | Map queue 0 from port 1 to lcore 20. |
+ | | | | |
+ +----------+-----------+-----------+---------------------------------------+
+ | 2 | 0 | 21 | Map queue 0 from port 2 to lcore 21. |
+ | | | | |
+ +----------+-----------+-----------+---------------------------------------+
+ | 3 | 0 | 21 | Map queue 0 from port 3 to lcore 21. |
+ | | | | |
+ +----------+-----------+-----------+---------------------------------------+
-* The --ep0 options configures the app with a given set of SP, SA and Routing
+* The ``--ep0`` options configures the app with a given set of SP, SA and Routing
entries as explained below in more detail.
Refer to the *DPDK Getting Started Guide* for general information on running
applications and the Environment Abstraction Layer (EAL) options.
The application would do a best effort to "map" crypto devices to cores, with
-hardware devices having priority.
+hardware devices having priority. Basically, hardware devices if present would
+be assigned to a core before software ones.
This means that if the application is using a single core and both hardware
and software crypto devices are detected, hardware devices will be used.
@@ -208,18 +214,35 @@ For example, something like the following command line:
.. code-block:: console
- ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048
- -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3
- --vdev "cryptodev_aesni_mb_pmd" --vdev "cryptodev_null_pmd" --
- -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)"
+ ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
+ -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \
+ --vdev "cryptodev_aesni_mb_pmd" --vdev "cryptodev_null_pmd" \
+ -- \
+ -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
--ep0
+
Configurations
--------------
The following sections provide some details on the default values used to
initialize the SP, SA and Routing tables.
-Currently all the configuration is hard coded into the application.
+Currently all configuration information is hard coded into the application.
+
+The following image illustrate a few of the concepts regarding IPSec, such
+as protected/unprotected and inbound/outbound traffic, from the point of
+view of two back-to-back endpoints:
+
+.. _figure_ipsec_endpoints:
+
+.. figure:: img/ipsec_endpoints.svg
+
+ IPSec Inbound/Outbound traffic
+
+Note that the above image only displays unidirectional traffic per port
+for illustration purposes.
+The application supports bidirectional traffic on all ports,
+
Security Policy Initialization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -228,107 +251,126 @@ As mention in the overview, the Security Policies are ACL rules.
The application defines two ACLs, one each of Inbound and Outbound, and
it replicates them per socket in use.
-Following are the default rules:
-
-Endpoint 0 Outbound Security Policies:
-
-+---------+------------------+-----------+------------+
-| **Src** | **Dst** | **proto** | **SA idx** |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.105.0/24 | Any | 5 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.106.0/24 | Any | 6 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.107.0/24 | Any | 7 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.108.0/24 | Any | 8 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.200.0/24 | Any | 9 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.250.0/24 | Any | BYPASS |
-| | | | |
-+---------+------------------+-----------+------------+
-
-Endpoint 0 Inbound Security Policies:
-
-+---------+------------------+-----------+------------+
-| **Src** | **Dst** | **proto** | **SA idx** |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.115.0/24 | Any | 5 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.116.0/24 | Any | 6 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.117.0/24 | Any | 7 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.118.0/24 | Any | 8 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.210.0/24 | Any | 9 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.240.0/24 | Any | BYPASS |
-| | | | |
-+---------+------------------+-----------+------------+
-
-Endpoint 1 Outbound Security Policies:
-
-+---------+------------------+-----------+------------+
-| **Src** | **Dst** | **proto** | **SA idx** |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.115.0/24 | Any | 5 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.116.0/24 | Any | 6 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.117.0/24 | Any | 7 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.118.0/24 | Any | 8 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.210.0/24 | Any | 9 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.240.0/24 | Any | BYPASS |
-| | | | |
-+---------+------------------+-----------+------------+
-
-Endpoint 1 Inbound Security Policies:
-
-+---------+------------------+-----------+------------+
-| **Src** | **Dst** | **proto** | **SA idx** |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.105.0/24 | Any | 5 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.106.0/24 | Any | 6 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.107.0/24 | Any | 7 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.108.0/24 | Any | 8 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.200.0/24 | Any | 9 |
-| | | | |
-+---------+------------------+-----------+------------+
-| Any | 192.168.250.0/24 | Any | BYPASS |
-| | | | |
-+---------+------------------+-----------+------------+
+Following are the default rules which show only the relevant information,
+assuming ANY value is valid for the fields not mentioned (src ip, proto,
+src/dst ports).
+
+.. _table_ipsec_endpoint_outbound_sp:
+
+.. table:: Endpoint 0 Outbound Security Policies
+
+ +-----------------------------------+------------+
+ | **Dst** | **SA idx** |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.105.0/24 | 5 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.106.0/24 | 6 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.175.0/24 | 10 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.176.0/24 | 11 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.200.0/24 | 15 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.201.0/24 | 16 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.55.0/24 | 25 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.56.0/24 | 26 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.240.0/24 | BYPASS |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.241.0/24 | BYPASS |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:0:0:5555:5555:0:0/96 | 5 |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:0:0:6666:6666:0:0/96 | 6 |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:1111:1111:0:0:0:0/96 | 10 |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:1111:1111:1111:1111:0:0/96 | 11 |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:0:0:aaaa:aaaa:0:0/96 | 25 |
+ | | |
+ +-----------------------------------+------------+
+ | 0:0:0:0:bbbb:bbbb:0:0/96 | 26 |
+ | | |
+ +-----------------------------------+------------+
+
+.. _table_ipsec_endpoint_inbound_sp:
+
+.. table:: Endpoint 0 Inbound Security Policies
+
+ +-----------------------------------+------------+
+ | **Dst** | **SA idx** |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.115.0/24 | 105 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.116.0/24 | 106 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.185.0/24 | 110 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.186.0/24 | 111 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.210.0/24 | 115 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.211.0/24 | 116 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.65.0/24 | 125 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.66.0/24 | 126 |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.245.0/24 | BYPASS |
+ | | |
+ +-----------------------------------+------------+
+ | 192.168.246.0/24 | BYPASS |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:0:0:5555:5555:0:0/96 | 105 |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:0:0:6666:6666:0:0/96 | 106 |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:1111:1111:0:0:0:0/96 | 110 |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:1111:1111:1111:1111:0:0/96 | 111 |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:0:0:aaaa:aaaa:0:0/96 | 125 |
+ | | |
+ +-----------------------------------+------------+
+ | ffff:0:0:0:bbbb:bbbb:0:0/96 | 126 |
+ | | |
+ +-----------------------------------+------------+
+
+For Endpoint 1, we use the same policies in reverse, meaning the Inbound SP
+entries are set as Outbound and vice versa.
Security Association Initialization
@@ -336,7 +378,7 @@ Security Association Initialization
The SAs are kept in a array table.
-For Inbound, the SPI is used as index module the table size.
+For Inbound, the SPI is used as index modulo the table size.
This means that on a table for 100 SA, SPI 5 and 105 would use the same index
and that is not currently supported.
@@ -346,179 +388,327 @@ not the SPI in the Security Policy.
All SAs configured with AES-CBC and HMAC-SHA1 share the same values for cipher
block size and key, and authentication digest size and key.
-Following are the default values:
-
-Endpoint 0 Outbound Security Associations:
-
-+---------+------------+-----------+----------------+------------------+
-| **SPI** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 5 | AES-CBC | HMAC-SHA1 | 172.16.1.5 | 172.16.2.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 6 | AES-CBC | HMAC-SHA1 | 172.16.1.6 | 172.16.2.6 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 7 | AES-CBC | HMAC-SHA1 | 172.16.1.7 | 172.16.2.7 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 8 | AES-CBC | HMAC-SHA1 | 172.16.1.8 | 172.16.2.8 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 9 | NULL | NULL | 172.16.1.5 | 172.16.2.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-
-Endpoint 0 Inbound Security Associations:
-
-+---------+------------+-----------+----------------+------------------+
-| **SPI** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 5 | AES-CBC | HMAC-SHA1 | 172.16.2.5 | 172.16.1.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 6 | AES-CBC | HMAC-SHA1 | 172.16.2.6 | 172.16.1.6 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 7 | AES-CBC | HMAC-SHA1 | 172.16.2.7 | 172.16.1.7 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 8 | AES-CBC | HMAC-SHA1 | 172.16.2.8 | 172.16.1.8 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 9 | NULL | NULL | 172.16.2.5 | 172.16.1.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-
-Endpoint 1 Outbound Security Associations:
-
-+---------+------------+-----------+----------------+------------------+
-| **SPI** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 5 | AES-CBC | HMAC-SHA1 | 172.16.2.5 | 172.16.1.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 6 | AES-CBC | HMAC-SHA1 | 172.16.2.6 | 172.16.1.6 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 7 | AES-CBC | HMAC-SHA1 | 172.16.2.7 | 172.16.1.7 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 8 | AES-CBC | HMAC-SHA1 | 172.16.2.8 | 172.16.1.8 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 9 | NULL | NULL | 172.16.2.5 | 172.16.1.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-
-Endpoint 1 Inbound Security Associations:
-
-+---------+------------+-----------+----------------+------------------+
-| **SPI** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 5 | AES-CBC | HMAC-SHA1 | 172.16.1.5 | 172.16.2.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 6 | AES-CBC | HMAC-SHA1 | 172.16.1.6 | 172.16.2.6 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 7 | AES-CBC | HMAC-SHA1 | 172.16.1.7 | 172.16.2.7 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 8 | AES-CBC | HMAC-SHA1 | 172.16.1.8 | 172.16.2.8 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
-| 9 | NULL | NULL | 172.16.1.5 | 172.16.2.5 |
-| | | | | |
-+---------+------------+-----------+----------------+------------------+
+The following are the default values:
+
+.. _table_ipsec_endpoint_outbound_sa:
+
+.. table:: Endpoint 0 Outbound Security Associations
+
+ +---------+----------+------------+-----------+----------------+----------------+
+ | **SPI** | **Mode** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 5 | Tunnel | AES-CBC | HMAC-SHA1 | 172.16.1.5 | 172.16.2.5 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 6 | Tunnel | AES-CBC | HMAC-SHA1 | 172.16.1.6 | 172.16.2.6 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 10 | Trans | AES-CBC | HMAC-SHA1 | N/A | N/A |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 11 | Trans | AES-CBC | HMAC-SHA1 | N/A | N/A |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 15 | Tunnel | NULL | NULL | 172.16.1.5 | 172.16.2.5 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 16 | Tunnel | NULL | NULL | 172.16.1.6 | 172.16.2.6 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 25 | Tunnel | AES-CBC | HMAC-SHA1 | 1111:1111: | 2222:2222: |
+ | | | | | 1111:1111: | 2222:2222: |
+ | | | | | 1111:1111: | 2222:2222: |
+ | | | | | 1111:5555 | 2222:5555 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 26 | Tunnel | AES-CBC | HMAC-SHA1 | 1111:1111: | 2222:2222: |
+ | | | | | 1111:1111: | 2222:2222: |
+ | | | | | 1111:1111: | 2222:2222: |
+ | | | | | 1111:6666 | 2222:6666 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+
+.. _table_ipsec_endpoint_inbound_sa:
+
+.. table:: Endpoint 0 Inbound Security Associations
+
+ +---------+----------+------------+-----------+----------------+----------------+
+ | **SPI** | **Mode** | **Cipher** | **Auth** | **Tunnel src** | **Tunnel dst** |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 105 | Tunnel | AES-CBC | HMAC-SHA1 | 172.16.2.5 | 172.16.1.5 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 106 | Tunnel | AES-CBC | HMAC-SHA1 | 172.16.2.6 | 172.16.1.6 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 110 | Trans | AES-CBC | HMAC-SHA1 | N/A | N/A |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 111 | Trans | AES-CBC | HMAC-SHA1 | N/A | N/A |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 115 | Tunnel | NULL | NULL | 172.16.2.5 | 172.16.1.5 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 116 | Tunnel | NULL | NULL | 172.16.2.6 | 172.16.1.6 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 125 | Tunnel | AES-CBC | HMAC-SHA1 | 2222:2222: | 1111:1111: |
+ | | | | | 2222:2222: | 1111:1111: |
+ | | | | | 2222:2222: | 1111:1111: |
+ | | | | | 2222:5555 | 1111:5555 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+ | 126 | Tunnel | AES-CBC | HMAC-SHA1 | 2222:2222: | 1111:1111: |
+ | | | | | 2222:2222: | 1111:1111: |
+ | | | | | 2222:2222: | 1111:1111: |
+ | | | | | 2222:6666 | 1111:6666 |
+ | | | | | | |
+ +---------+----------+------------+-----------+----------------+----------------+
+
+For Endpoint 1, we use the same policies in reverse, meaning the Inbound SP
+entries are set as Outbound and vice versa.
+
Routing Initialization
~~~~~~~~~~~~~~~~~~~~~~
-The Routing is implemented using LPM table.
+The Routing is implemented using an LPM table.
Following default values:
-Endpoint 0 Routing Table:
-
-+------------------+----------+
-| **Dst addr** | **Port** |
-| | |
-+------------------+----------+
-| 172.16.2.5/32 | 0 |
-| | |
-+------------------+----------+
-| 172.16.2.6/32 | 0 |
-| | |
-+------------------+----------+
-| 172.16.2.7/32 | 1 |
-| | |
-+------------------+----------+
-| 172.16.2.8/32 | 1 |
-| | |
-+------------------+----------+
-| 192.168.115.0/24 | 2 |
-| | |
-+------------------+----------+
-| 192.168.116.0/24 | 2 |
-| | |
-+------------------+----------+
-| 192.168.117.0/24 | 3 |
-| | |
-+------------------+----------+
-| 192.168.118.0/24 | 3 |
-| | |
-+------------------+----------+
-| 192.168.210.0/24 | 2 |
-| | |
-+------------------+----------+
-| 192.168.240.0/24 | 2 |
-| | |
-+------------------+----------+
-| 192.168.250.0/24 | 0 |
-| | |
-+------------------+----------+
-
-Endpoint 1 Routing Table:
-
-+------------------+----------+
-| **Dst addr** | **Port** |
-| | |
-+------------------+----------+
-| 172.16.1.5/32 | 2 |
-| | |
-+------------------+----------+
-| 172.16.1.6/32 | 2 |
-| | |
-+------------------+----------+
-| 172.16.1.7/32 | 3 |
-| | |
-+------------------+----------+
-| 172.16.1.8/32 | 3 |
-| | |
-+------------------+----------+
-| 192.168.105.0/24 | 0 |
-| | |
-+------------------+----------+
-| 192.168.106.0/24 | 0 |
-| | |
-+------------------+----------+
-| 192.168.107.0/24 | 1 |
-| | |
-+------------------+----------+
-| 192.168.108.0/24 | 1 |
-| | |
-+------------------+----------+
-| 192.168.200.0/24 | 0 |
-| | |
-+------------------+----------+
-| 192.168.240.0/24 | 2 |
-| | |
-+------------------+----------+
-| 192.168.250.0/24 | 0 |
-| | |
-+------------------+----------+
+.. _table_ipsec_endpoint_outbound_routing:
+
+.. table:: Endpoint 0 Routing Table
+
+ +------------------+----------+
+ | **Dst addr** | **Port** |
+ | | |
+ +------------------+----------+
+ | 172.16.2.5/32 | 0 |
+ | | |
+ +------------------+----------+
+ | 172.16.2.6/32 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.175.0/24 | 0 |
+ | | |
+ +------------------+----------+
+ | 192.168.176.0/24 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.240.0/24 | 0 |
+ | | |
+ +------------------+----------+
+ | 192.168.241.0/24 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.115.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.116.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.65.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.66.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.185.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.186.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.210.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.211.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.245.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.246.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 2222:2222: | 0 |
+ | 2222:2222: | |
+ | 2222:2222: | |
+ | 2222:5555/116 | |
+ | | |
+ +------------------+----------+
+ | 2222:2222: | 1 |
+ | 2222:2222: | |
+ | 2222:2222: | |
+ | 2222:6666/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 0 |
+ | 1111:1111: | |
+ | 0000:0000: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 1 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 2 |
+ | 0000:0000: | |
+ | aaaa:aaaa: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 3 |
+ | 0000:0000: | |
+ | bbbb:bbbb: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 2 |
+ | 0000:0000: | |
+ | 5555:5555: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 3 |
+ | 0000:0000: | |
+ | 6666:6666: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 2 |
+ | 1111:1111: | |
+ | 0000:0000: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 3 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+
+.. _table_ipsec_endpoint_inbound_routing:
+
+.. table:: Endpoint 1 Routing Table
+
+ +------------------+----------+
+ | **Dst addr** | **Port** |
+ | | |
+ +------------------+----------+
+ | 172.16.1.5/32 | 0 |
+ | | |
+ +------------------+----------+
+ | 172.16.1.6/32 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.185.0/24 | 0 |
+ | | |
+ +------------------+----------+
+ | 192.168.186.0/24 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.245.0/24 | 0 |
+ | | |
+ +------------------+----------+
+ | 192.168.246.0/24 | 1 |
+ | | |
+ +------------------+----------+
+ | 192.168.105.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.106.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.55.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.56.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.175.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.176.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.200.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.201.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 192.168.240.0/24 | 2 |
+ | | |
+ +------------------+----------+
+ | 192.168.241.0/24 | 3 |
+ | | |
+ +------------------+----------+
+ | 1111:1111: | 0 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 1111:5555/116 | |
+ | | |
+ +------------------+----------+
+ | 1111:1111: | 1 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 1111:6666/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 0 |
+ | 1111:1111: | |
+ | 0000:0000: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | ffff:0000: | 1 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 2 |
+ | 0000:0000: | |
+ | aaaa:aaaa: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 3 |
+ | 0000:0000: | |
+ | bbbb:bbbb: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 2 |
+ | 0000:0000: | |
+ | 5555:5555: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 3 |
+ | 0000:0000: | |
+ | 6666:6666: | |
+ | 0000:0/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 2 |
+ | 1111:1111: | |
+ | 0000:0000: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
+ | 0000:0000: | 3 |
+ | 1111:1111: | |
+ | 1111:1111: | |
+ | 0000:0000/116 | |
+ | | |
+ +------------------+----------+
--
2.5.5
next prev parent reply other threads:[~2016-06-09 8:43 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-06 16:31 [dpdk-dev] [PATCH 0/9] IPSec example enhancements Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 1/9] examples/ipsec-secgw: fix esp padding check Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 2/9] examples/ipsec-secgw: fix stack smashing error Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 3/9] examples/ipsec-secgw: add build option and cleanup Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 4/9] examples/ipsec-secgw: rework ipsec execution loop Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 5/9] examples/ipsec-secgw: fix no sa found case Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 6/9] examples/ipsec-secgw: consistent config variable names Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 7/9] examples/ipsec-secgw: ipv6 support Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 8/9] examples/ipsec-secgw: transport mode support Sergio Gonzalez Monroy
2016-05-06 16:31 ` [dpdk-dev] [PATCH 9/9] doc: update ipsec sample guide Sergio Gonzalez Monroy
2016-05-10 9:21 ` Mcnamara, John
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 0/9] IPSec enhancements Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 1/9] examples/ipsec-secgw: fix esp padding check Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 2/9] examples/ipsec-secgw: fix stack smashing error Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 3/9] examples/ipsec-secgw: add build option and cleanup Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 4/9] examples/ipsec-secgw: rework ipsec execution loop Sergio Gonzalez Monroy
2016-06-07 12:50 ` De Lara Guarch, Pablo
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 5/9] examples/ipsec-secgw: fix no sa found case Sergio Gonzalez Monroy
2016-06-07 13:17 ` De Lara Guarch, Pablo
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 6/9] examples/ipsec-secgw: consistent config variable names Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 7/9] examples/ipsec-secgw: ipv6 support Sergio Gonzalez Monroy
2016-06-07 16:10 ` De Lara Guarch, Pablo
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 8/9] examples/ipsec-secgw: transport mode support Sergio Gonzalez Monroy
2016-05-18 12:42 ` [dpdk-dev] [PATCH v2 9/9] doc: update ipsec sample guide Sergio Gonzalez Monroy
2016-05-18 13:43 ` Mcnamara, John
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 0/9] IPSec Enhancements Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 1/9] examples/ipsec-secgw: fix esp padding check Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 2/9] examples/ipsec-secgw: fix stack smashing error Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 3/9] examples/ipsec-secgw: add build option and cleanup Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 4/9] examples/ipsec-secgw: rework ipsec execution loop Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 5/9] examples/ipsec-secgw: fix no sa found case Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 6/9] examples/ipsec-secgw: consistent config variable names Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 7/9] examples/ipsec-secgw: ipv6 support Sergio Gonzalez Monroy
2016-06-09 8:42 ` [dpdk-dev] [PATCH v3 8/9] examples/ipsec-secgw: transport mode support Sergio Gonzalez Monroy
2016-06-09 8:42 ` Sergio Gonzalez Monroy [this message]
2016-06-09 11:11 ` [dpdk-dev] [PATCH v3 9/9] doc: update ipsec sample guide Mcnamara, John
2016-06-09 11:58 ` [dpdk-dev] [PATCH v3 0/9] IPSec Enhancements De Lara Guarch, Pablo
2016-06-21 10:14 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1465461770-42233-10-git-send-email-sergio.gonzalez.monroy@intel.com \
--to=sergio.gonzalez.monroy@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=pablo.de.lara.guarch@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).