File: audit.rst

package info (click to toggle)
python-hvac 2.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,800 kB
  • sloc: python: 29,360; makefile: 42; sh: 14
file content (132 lines) | stat: -rw-r--r-- 2,534 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
Audit
=====

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

Examples
--------

.. testcode:: sys_audit

    audit_devices = client.sys.list_enabled_audit_devices()

    options = {
        'path': '/tmp/vault.log',
        'log_raw': True,
    }

    client.sys.enable_audit_device('file', options=options, path='somefile')
    client.sys.disable_audit_device('oldfile')


List Enabled Audit Devices
--------------------------

.. automethod:: hvac.api.system_backend.Audit.list_enabled_audit_devices
   :noindex:

Examples
````````

.. testcode:: sys_audit

    import hvac
    client = hvac.Client(url='https://127.0.0.1:8200')

    enabled_audit_devices = client.sys.list_enabled_audit_devices()
    print('The following audit devices are enabled: {audit_devices_list}'.format(
        audit_devices_list=', '.join(enabled_audit_devices['data'].keys()),
    ))

Example output:

.. testoutput:: sys_audit

    The following audit devices are enabled: somefile/

Enable Audit Device
-------------------

.. automethod:: hvac.api.system_backend.Audit.enable_audit_device
   :noindex:

Examples
````````

.. testcode:: sys_audit

    import hvac
    client = hvac.Client(url='https://127.0.0.1:8200')

    options = {
        'path': '/tmp/vault.audit.log'
    }

    client.sys.enable_audit_device(
        device_type='file',
        options=options,
        path='tmp-file-audit',
    )


Disable Audit Device
--------------------

.. automethod:: hvac.api.system_backend.Audit.disable_audit_device
   :noindex:

Examples
````````

.. testcode:: sys_audit

    import hvac
    client = hvac.Client(url='https://127.0.0.1:8200')

    client.sys.disable_audit_device(
        path='tmp-file-audit',
    )


Calculate Hash
--------------

.. automethod:: hvac.api.system_backend.Audit.calculate_hash
   :noindex:

Examples
````````

.. testsetup:: sys_audit_calculate_hash

    options = {
        'path': '/tmp/vault.audit.log'
    }

    client.sys.enable_audit_device(
        device_type='file',
        options=options,
        path='tmp-file-audit',
    )

.. testcode:: sys_audit_calculate_hash

    import hvac
    client = hvac.Client(url='https://127.0.0.1:8200')

    input_to_hash = 'some sort of string thinger'

    audit_hash = client.sys.calculate_hash(
        path='tmp-file-audit',
        input_to_hash=input_to_hash,
    )

    print('The hash for the provided input is: %s' % audit_hash['data']['hash'])

Example output:

.. testoutput:: sys_audit_calculate_hash

    The hash for the provided input is: hmac-sha256:...