[PATCH 3/4] lnst.Recipes.ENRT.XfrmTools: add documentation

From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;

Signed-off-by: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;
---
 lnst/Recipes/ENRT/XfrmTools.py | 36 ++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/lnst/Recipes/ENRT/XfrmTools.py b/lnst/Recipes/ENRT/XfrmTools.py
index fd226fc..789b42d 100644
--- a/lnst/Recipes/ENRT/XfrmTools.py
+++ b/lnst/Recipes/ENRT/XfrmTools.py
@@ -1,12 +1,32 @@
 from lnst.Common.LnstError import LnstError
 
 def generate_key(length):
+    """
+    Method generates key suitable for the IPsec.
+
+    :param length: Desired length of the generated key
+    :return: key
+    """
     key = "0x"
     key = key + (length//8) * "0b"
     return key
 
 def configure_ipsec_esp_aead(m1, ip1, m2, ip2, algo, algo_key, icv_len,
                              ipsec_mode, spi_vals):
+    """
+    Configuration of the IPsec is executed through iproute2's ip-xfrm
+    tool. Method creates state and policy for the ESP AEAD IPsec.
+
+    :param m1: :any:`RemoteDevice` class describing tunnel's endpoint
+    :param ip1: :any:`Device` class containing IP addresses of given device under test
+    :param m2: :any:`RemoteDevice` class describing other side of tunnel endpoint
+    :param ip2: :any:`Device` class containing IP addresses of other side of the tunnel
+    :param algo: Algorithm chosen for the tunnel's ESP
+    :param algo_key: Generated key for the encryption algorithm
+    :param icv_len: Length of ICV for the AEAD encryption protocol
+    :param ipsec_mode: Mode of the ESP
+    :param spi_vals: SPI value for the identification
+    """
     for m, in1, in2,  in [(m1, ip2, ip1), (m2, ip1, ip2)]:
         m.run("ip xfrm policy flush")
         m.run("ip xfrm state flush")
@@ -37,6 +57,22 @@ def configure_ipsec_esp_aead(m1, ip1, m2, ip2, algo, algo_key,
icv_len,
 
 def configure_ipsec_esp_ah_comp(m1, ip1, m2, ip2, ciph_alg, ciph_key, hash_alg,
                                 hash_key, ipsec_mode, spi_vals):
+    """
+    Configuration of the IPsec is executed through iproute2's ip-xfrm
+    tool. Method creates state and policy for the ESP AH IPsec.
+
+    :param m1: :any:`RemoteDevice` class describing tunnel's endpoint
+    :param ip1: :any:`Device` class containing IP addresses of given device under test
+    :param m2: :any:`RemoteDevice` class describing other side of tunnel endpoint
+    :param ip2: :any:`Device` class containing IP addresses of other side of the tunnel
+    :param ciph_alg: Cipher algorithm chosen for the tunnel's ESP
+    :param ciph_key: Generated key for the encryption algorithm
+    :param hash_alg: Algorithm for AH part of IPsec
+    :param hash_key: Generated key for the authentication protocol
+    :param icv_len: Length of ICV for the AH encryption protocol
+    :param ipsec_mode: Mode of the ESP
+    :param spi_vals: SPI value for the identification
+    """
     m_keys = []
     for m in [m1, m2]:
         res = m.run("rpm -qa iproute")
-- 
2.25.4