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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>aa-easyprof - AppArmor profile generation made easy.</title>
<link rel="stylesheet" href="apparmor.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="_podblock_" valign="middle">
<big><strong><span class="_podblock_"> aa-easyprof - AppArmor profile generation made easy.</span></strong></big>
</td></tr>
</table>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#OPTIONS">OPTIONS</a></li>
<li><a href="#EXAMPLES">EXAMPLES</a></li>
<li><a href="#BUGS">BUGS</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>aa-easyprof - AppArmor profile generation made easy.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<p><b>aa-easyprof</b> [option] <path to binary></p>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p><b>aa-easyprof</b> provides an easy to use interface for AppArmor policy generation. <b>aa-easyprof</b> supports the use of templates and policy groups to quickly profile an application. Please note that while this tool can help with policy generation, its utility is dependent on the quality of the templates, policy groups and abstractions used. Also, this tool may create policy which is less restricted than creating policy by hand or with <b>aa-genprof</b> and <b>aa-logprof</b>.</p>
<h1 id="OPTIONS">OPTIONS</h1>
<p><b>aa-easyprof</b> accepts the following arguments:</p>
<dl>
<dt id="t-TEMPLATE---template-TEMPLATE">-t TEMPLATE, --template=TEMPLATE</dt>
<dd>
<p>Specify which template to use. May specify either a system template from /usr/share/apparmor/easyprof/templates or a filename for the template to use. If not specified, use /usr/share/apparmor/easyprof/templates/default.</p>
</dd>
<dt id="p-POLICYGROUPS---policy-groups-POLICYGROUPS">-p POLICYGROUPS, --policy-groups=POLICYGROUPS</dt>
<dd>
<p>Specify POLICY as a comma-separated list of policy groups. See --list-templates for supported policy groups. The available policy groups are in /usr/share/apparmor/easyprof/policy. Policy groups are simply groupings of AppArmor rules or policies. They are similar to AppArmor abstractions, but usually encompass more policy rules.</p>
</dd>
<dt id="parser-PATH">--parser PATH</dt>
<dd>
<p>Specify the PATH of the apparmor_parser binary to use when verifying policy. If this option is not specified, aa-easyprof will attempt to locate the path starting with /sbin/apparmor_parser.</p>
</dd>
<dt id="a-ABSTRACTIONS---abstractions-ABSTRACTIONS">-a ABSTRACTIONS, --abstractions=ABSTRACTIONS</dt>
<dd>
<p>Specify ABSTRACTIONS as a comma-separated list of AppArmor abstractions. It is usually recommended you use policy groups instead, but this is provided as a convenience. AppArmor abstractions are located in /etc/apparmor.d/abstractions. See apparmor.d(5) for details.</p>
</dd>
<dt id="b-PATH---base-PATH">-b PATH, --base=PATH</dt>
<dd>
<p>Set the base PATH for resolving abstractions specified by --abstractions. See the same option in apparmor_parser(8) for details.</p>
</dd>
<dt id="I-PATH---Include-PATH">-I PATH, --Include=PATH</dt>
<dd>
<p>Add PATH to the search paths used for resolving abstractions specified by --abstractions. See the same option in apparmor_parser(8) for details.</p>
</dd>
<dt id="r-PATH---read-path-PATH">-r PATH, --read-path=PATH</dt>
<dd>
<p>Specify a PATH to allow owner reads. May be specified multiple times. If the PATH ends in a '/', then PATH is treated as a directory and reads are allowed to all files under this directory. Can optionally use '/*' at the end of the PATH to only allow reads to files directly in PATH.</p>
</dd>
<dt id="w-PATH---write-dir-PATH">-w PATH, --write-dir=PATH</dt>
<dd>
<p>Like --read-path but also allow owner writes in additions to reads.</p>
</dd>
<dt id="n-NAME---name-NAME">-n NAME, --name=NAME</dt>
<dd>
<p>Specify NAME of policy. If not specified, NAME is set to the name of the binary. The NAME of the policy is typically only used for profile meta data and does not specify the AppArmor profile name.</p>
</dd>
<dt id="profile-name-PROFILENAME">--profile-name=PROFILENAME</dt>
<dd>
<p>Specify the AppArmor profile name. When set, uses 'profile PROFILENAME' in the profile. When set and specifying a binary, uses 'profile PROFILENAME BINARY' in the profile. If not set, the binary will be used as the profile name and profile attachment.</p>
</dd>
<dt id="template-var-VAR-VALUE">--template-var="@{VAR}=VALUE"</dt>
<dd>
<p>Set VAR to VALUE in the resulting policy. This typically only makes sense if the specified template uses this value. May be specified multiple times.</p>
</dd>
<dt id="list-templates">--list-templates</dt>
<dd>
<p>List available templates.</p>
</dd>
<dt id="show-template">--show-template</dt>
<dd>
<p>Display template specified with --template.</p>
</dd>
<dt id="templates-dir-PATH">--templates-dir=PATH</dt>
<dd>
<p>Use PATH instead of system templates directory.</p>
</dd>
<dt id="include-templates-dir-PATH">--include-templates-dir=PATH</dt>
<dd>
<p>Include PATH when searching for templates in addition to the system templates directory (or the one specified with --templates-dir). System templates will match before those in PATH.</p>
</dd>
<dt id="list-policy-groups">--list-policy-groups</dt>
<dd>
<p>List available policy groups.</p>
</dd>
<dt id="show-policy-group">--show-policy-group</dt>
<dd>
<p>Display policy groups specified with --policy-groups.</p>
</dd>
<dt id="policy-groups-dir-PATH">--policy-groups-dir=PATH</dt>
<dd>
<p>Use PATH instead of system policy-groups directory.</p>
</dd>
<dt id="include-policy-groups-dir-PATH">--include-policy-groups-dir=PATH</dt>
<dd>
<p>Include PATH when searching for policy groups in addition to the system policy-groups directory (or the one specified with --policy-groups-dir). System policy-groups will match before those in PATH.</p>
</dd>
<dt id="policy-version-VERSION">--policy-version=VERSION</dt>
<dd>
<p>Must be used with --policy-vendor and is used to specify the version of policy groups and templates. When specified, <b>aa-easyprof</b> looks for the subdirectory VENDOR/VERSION within the policy-groups and templates directory. The specified version must be a positive decimal number compatible with the JSON Number type. Eg, when using:</p>
<pre><code>$ aa-easyprof --templates-dir=/usr/share/apparmor/easyprof/templates \
--policy-groups-dir=/usr/share/apparmor/easyprof/policygroups \
--policy-vendor="foo" \
--policy-version=1.0</code></pre>
<p>Then /usr/share/apparmor/easyprof/templates/foo/1.0 will be searched for templates and /usr/share/apparmor/easyprof/policygroups/foo/1.0 for policy groups.</p>
</dd>
<dt id="policy-vendor-VENDOR">--policy-vendor=VENDOR</dt>
<dd>
<p>Must be used with --policy-version and is used to specify the vendor for policy groups and templates. See --policy-version for more information.</p>
</dd>
<dt id="author">--author</dt>
<dd>
<p>Specify author of the policy.</p>
</dd>
<dt id="copyright">--copyright</dt>
<dd>
<p>Specify copyright of the policy.</p>
</dd>
<dt id="comment">--comment</dt>
<dd>
<p>Specify comment for the policy.</p>
</dd>
<dt id="m-MANIFEST---manifest-MANIFEST">-m MANIFEST, --manifest=MANIFEST</dt>
<dd>
<p><b>aa-easyprof</b> also supports using a JSON manifest file for specifying options related to policy. Unlike command line arguments, the JSON file may specify multiple profiles. The structure of the JSON is:</p>
<pre><code>{
"security": {
"profiles": {
"<profile name 1>": {
... attributes specific to this profile ...
},
"<profile name 2>": {
...
}
}
}
}</code></pre>
<p>Each profile JSON object (ie, everything under a profile name) may specify any fields related to policy. The "security" JSON container object is optional and may be omitted. An example manifest file demonstrating all fields is:</p>
<pre><code>{
"security": {
"profiles": {
"com.example.foo": {
"abstractions": [
"audio",
"gnome"
],
"author": "Your Name",
"binary": "/opt/foo/**",
"comment": "Unstructured single-line comment",
"copyright": "Unstructured single-line copyright statement",
"name": "My Foo App",
"policy_groups": [
"networking",
"user-application"
],
"policy_vendor": "somevendor",
"policy_version": 1.0,
"read_path": [
"/tmp/foo_r",
"/tmp/bar_r/"
],
"template": "user-application",
"template_variables": {
"APPNAME": "foo",
"VAR1": "bar",
"VAR2": "baz"
},
"write_path": [
"/tmp/foo_w",
"/tmp/bar_w/"
]
}
}
}
}</code></pre>
<p>A manifest file does not have to include all the fields. Eg, a manifest file for an Ubuntu SDK application might be:</p>
<pre><code>{
"security": {
"profiles": {
"com.ubuntu.developer.myusername.MyCoolApp": {
"policy_groups": [
"networking",
"online-accounts"
],
"policy_vendor": "ubuntu",
"policy_version": 1.0,
"template": "ubuntu-sdk",
"template_variables": {
"APPNAME": "MyCoolApp",
"APPVERSION": "0.1.2"
}
}
}
}
}</code></pre>
</dd>
<dt id="verify-manifest">--verify-manifest</dt>
<dd>
<p>When used with --manifest, warn about potentially unsafe definitions in the manifest file.</p>
</dd>
<dt id="output-format-FORMAT">--output-format=FORMAT</dt>
<dd>
<p>Specify either <b>text</b> (default if unspecified) for AppArmor policy output or <b>json</b> for JSON manifest format.</p>
</dd>
<dt id="output-directory-DIR">--output-directory=DIR</dt>
<dd>
<p>Specify output directory for profile. If unspecified, policy is sent to stdout.</p>
</dd>
</dl>
<h1 id="EXAMPLES">EXAMPLES</h1>
<p>Example usage for a program named 'foo' which is installed in /opt/foo:</p>
<pre><code>$ aa-easyprof --template=user-application --template-var="@{APPNAME}=foo" \
--policy-groups=opt-application,user-application \
/opt/foo/bin/FooApp</code></pre>
<p>When using a manifest file:</p>
<pre><code>$ aa-easyprof --manifest=manifest.json</code></pre>
<p>To output a manifest file based on aa-easyprof arguments:</p>
<pre><code>$ aa-easyprof --output-format=json \
--author="Your Name" \
--comment="Unstructured single-line comment" \
--copyright="Unstructured single-line copyright statement" \
--name="My Foo App" \
--profile-name="com.example.foo" \
--template="user-application" \
--policy-groups="user-application,networking" \
--abstractions="audio,gnome" \
--read-path="/tmp/foo_r" \
--read-path="/tmp/bar_r/" \
--write-path="/tmp/foo_w" \
--write-path=/tmp/bar_w/ \
--template-var="@{APPNAME}=foo" \
--template-var="@{VAR1}=bar" \
--template-var="@{VAR2}=baz" \
"/opt/foo/**"</code></pre>
<h1 id="BUGS">BUGS</h1>
<p>If you find any additional bugs, please report them to GitLab at <a href="https://gitlab.com/apparmor/apparmor/-/issues">https://gitlab.com/apparmor/apparmor/-/issues</a>.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p>apparmor(7) apparmor.d(5)</p>
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="_podblock_" valign="middle">
<big><strong><span class="_podblock_"> aa-easyprof - AppArmor profile generation made easy.</span></strong></big>
</td></tr>
</table>
</body>
</html>
|
