:source: fwebos_waf_cookie_security.py

:orphan:

.. fwebos_waf_cookie_security.py:

fwebos_waf_cookie_security.py -- Config FortiWeb Web Protection Cookie Security
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.1

.. contents::
   :local:
   :depth: 1


Synopsis
--------
Config FortiWeb Web Protection Cookie Security


Requirements
------------
The below requirements are needed on the host that executes this module.

- ansible>=2.11


FortiWeb Version Compatibility
------------------------------


.. raw:: html

 <br>
 <table>
 <tr>
 <td></td>
 <td><code class="docutils literal notranslate">v7.0.x </code></td>
 <td><code class="docutils literal notranslate">v7.2.x </code></td>
 <td><code class="docutils literal notranslate">v7.4.x </code></td>
 <td><code class="docutils literal notranslate">v7.6.x </code></td>
 </tr>
 <tr>
 <td>fwebos_waf_cookie_security.py</td>
 <td>yes</td>
 <td>yes</td>
 <td>yes</td>
 <td>yes</td>
 </tr>
 </table>
 <p>



Parameters
----------


.. raw:: html


  <ul>
  <li><span class="li-head">body</span> Possible parameters to go in the body for the request <span class="li-required">required: True </li>
        <ul class="ul-self">
              <li><span class="li-head"> name </span> name <span class="li-normal"> type:string
                    maxLength:63</span></li>
              <li><span class="li-head"> cookie-security-exception-list </span> cookie security exception list <span class="li-normal"> type:array
                    <ul class="ul-self">
                      <li> <span class="li-head"> id </span> The number of the cookie security exception list  </li>
                      <li> <span class="li-head"> cookie-name </span> cookie name </li>
                      <li> <span class="li-head"> cookie-domain </span> cookie domain  </li>
                      <li> <span class="li-head"> cookie-path </span> cookie path </li>
                      <li> <span class="li-head"> wildcard </span> treat asterisk in cookie-name as wildcard </li>
                    </ul></span></li>
              <li><span class="li-head"> security-mode </span> security mode  <span class="li-normal"> type:string choice:
                      no,
                      encrypted,
                      signed,</span></li>
              <li><span class="li-head"> action </span> action <span class="li-normal"> type:string choice:
                      alert,
                      deny_no_log,
                      alert_deny,
                      remove_cookie,
                      block-period,
                      client-id-block-period,</span></li>
              <li><span class="li-head"> block-period </span> action block period(1-3600) <span class="li-normal"> type:integer
                    maximum:3600
                    minimum:1</span></li>
              <li><span class="li-head"> severity </span> High, Medium, Low or Informative <span class="li-normal"> type:string choice:
                      High,
                      Medium,
                      Low,
                      Info,</span></li>
              <li><span class="li-head"> trigger </span> choose Email or syslog policy <span class="li-normal"> type:string</span></li>
              <li><span class="li-head"> cookie-replay-protection-type </span> cookie replay protection type <span class="li-normal"> type:string choice:
                      no,
                      IP,</span></li>
              <li><span class="li-head"> max-age </span> max-age(0-65535) <span class="li-normal"> type:integer
                    maximum:65535
                    minimum:0</span></li>
              <li><span class="li-head"> secure-cookie </span> secure cookie  <span class="li-normal"> type:string choice:
                      enable,
                      disable,</span></li>
              <li><span class="li-head"> http-only </span> http only  <span class="li-normal"> type:string choice:
                      enable,
                      disable,</span></li>
              <li><span class="li-head"> allow-suspicious-cookies </span> allow suspicious cookies <span class="li-normal"> type:string choice:
                      Never,
                      Always,
                      Custom,</span></li>
              <li><span class="li-head"> allow-time </span> allow date <yyyy/mm/dd> <span class="li-normal"> type:string</span></li>
        <li><span class="li-head">mkey</span> If present, objects will be filtered on property with this name  <span class="li-normal"> type:string </span></li><li><span class="li-head">vdom</span> Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)   <span class="li-normal"> type:array </span></li><li><span class="li-head">clone_mkey</span> Use *clone_mkey* to specify the ID for the new resource to be cloned.  If *clone_mkey* is set, *mkey* must be provided which is cloned from.   <span class="li-normal"> type:string </span></li>
  </ul>

Examples
--------
.. code-block:: yaml+jinja

 - name:
   hosts: all
   vars:
   connection: httpapi
   gather_facts: false
   tasks:
     - name: delete 
       fwebos_waf_cookie_security:
        action: delete 
        vdom: root
        name: test 
           
     - name: Create 
       fwebos_waf_cookie_security:
        action: add 
        vdom: root
        security_mode: encrypted
        cookie_replay_protection_type: IP
        allow_suspicious_cookies: Custom
        allow_time_model: 2022-10-28T17:11:54.000Z
        security_action: alert
        severity: Medium
        block_period: 600
        max_age: 0
        http_only: disable
        name: test
        trigger: test
        allow_time: 2022/10/28
 
     - name: edit
       fwebos_waf_cookie_security:
        action: edit 
        vdom: root
        security_mode: encrypted
        cookie_replay_protection_type: IP
        allow_suspicious_cookies: Custom
        allow_time_model: 2022-10-28T17:11:54.000Z
        security_action: alert
        severity: Medium
        block_period: 600
        max_age: 0
        http_only: disable
        name: test
        trigger: test
        allow_time: 2022/10/27
 

Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

.. raw:: html

    <ul><li><span class="li-return"> 200 </span> : OK: Request returns successful</li>
      <li><span class="li-return"> 400 </span> : Bad Request: Request cannot be processed by the API</li>
      <li><span class="li-return"> 401 </span> : Not Authorized: Request without successful login session</li>
      <li><span class="li-return"> 403 </span> : Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.</li>
      <li><span class="li-return"> 404 </span> : Resource Not Found: Unable to find the specified resource.</li>
      <li><span class="li-return"> 405 </span> : Method Not Allowed: Specified HTTP method is not allowed for this resource. </li>
      <li><span class="li-return"> 413 </span> : Request Entity Too Large: Request cannot be processed due to large entity </li>
      <li><span class="li-return"> 424 </span> : Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value</li>
      <li><span class="li-return"> 429 </span> : Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.</li>
      <li><span class="li-return"> 500 </span> : Internal Server Error: Internal error when processing the request </li>
      
    </ul>

For errorcode please check FortiWeb API errorcode at : https://documenter.getpostman.com/view/11233300/TVetbkaK#887b9eb4-7c13-4338-a8db-16cc117f0119

Status
------

- This module is not guaranteed to have a backwards compatible interface.


Authors
-------

- Jie Li
- Brad Zhang

.. hint::
	If you notice any issues in this documentation, you can create a pull request to improve it.