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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
Policy
======
.. contents::
:local:
:depth: 1
Manipulate policies
-------------------
.. testcode:: sys_policy
policies = client.sys.list_policies()['data']['policies'] # => ['root']
policy = """
path "sys" {
capabilities = ["deny"]
}
path "secret/*" {
capabilities = ["read", "list"]
}
path "secret/foo" {
capabilities = ["create", "read", "update", "delete", "list"]
}
"""
client.sys.create_or_update_policy(
name='secret-writer',
policy=policy,
)
client.sys.delete_policy('oldthing')
# The get_policy method offers some additional features and is available in the Client class.
policy = client.get_policy('mypolicy')
# Requires pyhcl to automatically parse HCL into a Python dictionary
policy = client.get_policy('mypolicy', parse=True)
Using Python Variable(s) In Policy Rules
````````````````````````````````````````
.. testcode:: sys_policy
import hvac
client = hvac.Client(url='https://127.0.0.1:8200')
key = 'some-key-string'
policy_body = """
path "transit/encrypt/%s" {
capabilities = ["update"]
}
""" % key
client.sys.create_or_update_policy(
name='my-policy-name',
policy=policy_body,
)
List Policies
-------------
.. automethod:: hvac.api.system_backend.Policy.list_policies
:noindex:
Examples
````````
.. testcode:: sys_policy
import hvac
client = hvac.Client(url='https://127.0.0.1:8200')
list_policies_resp = client.sys.list_policies()['data']['policies']
print('List of currently configured policies: %s' % ', '.join(list_policies_resp))
Example output:
.. testoutput:: sys_policy
List of currently configured policies: default, my-policy-name, secret-writer, root
Read Policy
-----------
.. automethod:: hvac.api.system_backend.Policy.read_policy
:noindex:
Examples
````````
.. testcode:: sys_policy
import hvac
client = hvac.Client(url='https://127.0.0.1:8200')
hvac_policy_rules = client.sys.read_policy(name='secret-writer')['data']['rules']
print('secret-writer policy rules:\n%s' % hvac_policy_rules)
Example output:
.. testoutput:: sys_policy
secret-writer policy rules:
path "sys" {
capabilities = ["deny"]
}
path "secret/*" {
capabilities = ["read", "list"]
}
path "secret/foo" {
capabilities = ["create", "read", "update", "delete", "list"]
}
...
Create Or Update Policy
-----------------------
.. automethod:: hvac.api.system_backend.Policy.create_or_update_policy
:noindex:
Examples
````````
.. testcode:: sys_policy
import hvac
client = hvac.Client(url='https://127.0.0.1:8200')
policy = '''
path "sys" {
capabilities = ["deny"]
}
path "secret" {
capabilities = ["create", "read", "update", "delete", "list"]
}
'''
client.sys.create_or_update_policy(
name='secret-writer',
policy=policy,
)
Delete Policy
-------------
.. automethod:: hvac.api.system_backend.Policy.delete_policy
:noindex:
Examples
````````
.. testcode:: sys_policy
import hvac
client = hvac.Client(url='https://127.0.0.1:8200')
client.sys.delete_policy(
name='secret-writer',
)
|
