diff options
| author | Bill Fischofer <bill.fischofer@linaro.org> | 2017-11-15 17:12:36 -0600 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2017-12-27 21:41:47 +0300 |
| commit | ebe1dae396dd674d61e299bf0668a260368e8bd2 (patch) | |
| tree | 145e8d2a7b82600f1815b33d74c96f129ff0d729 /doc/users-guide | |
| parent | 7f92fe1b0fc6256b9b9fd43216f4b42286dd1ae3 (diff) | |
doc: userguide: ipsec state machine changes
Replace the FSMs used to describe SA state transitions and IPsec
operations with a Message Sequence Diagram (MSC) that shows the
same information in an easier to follow form.
Update User Guide to reflect these changes as well.
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc/users-guide')
| -rw-r--r-- | doc/users-guide/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/users-guide/users-guide-ipsec.adoc | 9 |
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am index 54f87bb63..b2ebd4d4f 100644 --- a/doc/users-guide/Makefile.am +++ b/doc/users-guide/Makefile.am @@ -11,7 +11,7 @@ SRC = users-guide.adoc \ TARGET = users-guide.html IMAGES = $(IMAGES_DIR)/overview.svg \ $(IMAGES_DIR)/atomic_queue.svg \ - $(IMAGES_DIR)/ipsec_fsm.svg \ + $(IMAGES_DIR)/ipsec_sa_states.svg \ $(IMAGES_DIR)/odp_components.svg \ $(IMAGES_DIR)/ODP-Logo-HQ.svg \ $(IMAGES_DIR)/odp_rx_processing.svg \ @@ -48,7 +48,7 @@ IMAGES += $(IMAGES_DIR)/resource_management.svg endif IMAGES_SRCS = \ - $(IMAGES_DIR)/ipsec_fsm.gv \ + $(IMAGES_DIR)/ipsec_sa_states.msc \ $(IMAGES_DIR)/pktio_fsm.gv \ $(IMAGES_DIR)/resource_management.msc \ $(IMAGES_DIR)/timeout_fsm.gv \ diff --git a/doc/users-guide/users-guide-ipsec.adoc b/doc/users-guide/users-guide-ipsec.adoc index d560df9c4..ac4eae85d 100644 --- a/doc/users-guide/users-guide-ipsec.adoc +++ b/doc/users-guide/users-guide-ipsec.adoc @@ -244,12 +244,13 @@ IPsec operations may produce. This can be changed dynamically by the As can be seen, SAs have a large degree of configurability. ==== SA Lifecycle Management -In discussing the lifecycle of an SA, it is useful to refer to the following -state diagram: +In discussing the lifecycle of an SA and the operations it supports, it is +useful to refer to the following sequence diagram for IPsec configuration, SA +management, and IPsec operations: -image::ipsec_fsm.svg[align="center"] +image:ipsec_sa_states.svg[align="center"] -After creation, IPsec services are active for this Security Association. The +After creation, IPsec services are active for this Security Association. The specific APIs that can be used on this SA depends on the IPsec operating mode that has been configured. |