← Back to branch summary

~ubuntu-branches/ubuntu/maverick/samba/maverick-security

« back to all changes in this revision

Viewing changes to docs/manpages/vfs_smb_traffic_analyzer.8

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-01-29 06:16:15 UTC
  • mfrom: (0.27.9 upstream) (0.34.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100129061615-37hs6xqpsdhjq3ld
Tags: 2:3.4.5~dfsg-1ubuntu1
https://launchpad.net/bugs/462169
https://launchpad.net/bugs/493565
* Merge from debian testing.  Remaining changes:
  + debian/patches/VERSION.patch:
    - set SAMBA_VERSION_SUFFIX to Ubuntu.
  + debian/smb.conf:
    - Add "(Samba, Ubuntu)" to server string.
    - Comment out the default [homes] share, and add a comment about "valid users = %s"
      to show users how to restrict access to \\server\username to only username.
    - Set 'usershare allow guests', so that usershare admins are allowed to create
      public shares in additon to authenticated ones.
    - add map to guest = Bad user, maps bad username to gues access.
  + debian/samba-common.conf:
    - Do not change priority to high if dhclient3 is installed.
    - Use priority medium instead of high for the workgroup question.
  + debian/mksambapasswd.awk:
    - Do not add user with UID less than 1000 to smbpasswd.
  + debian/control: 
    - Make libswbclient0 replace/conflict with hardy's likewise-open.
    - Don't build against ctdb, since its not in main yet.
  + debian/rules:
    - Enable "native" PIE hardening.
    - Add BIND_NOW to maximize benefit of RELRO hardening.
  + Add ufw integration:
    - Created debian/samba.ufw.profile.
    - debian/rules, debian/samba.dirs, debian/samba.files: install
  + Add apoort hook:
    - Created debian/source_samba.py.
    - debian/rules, debian/samba.dirs, debian/samba-common-bin.files: install
  + debian/rules, debian/samba.if-up: allow "NetworkManager" as a recognized address
    family... it's obviously /not/ an address family, but it's what gets
    sent when using NM, so we'll cope for now.  (LP: #462169). Taken from karmic-proposed.
  + debian/control: Recommend keyutils for smbfs (LP: #493565)
  + Dropped patches:
    - debian/patches/security-CVE-2009-3297.patch: No longer needed
    - debian/patches/fix-too-many-open-files.patch: No longer needed

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manpages/vfs_smb_traffic_analyzer.8
 
1
'\" t
1
2
.\"     Title: smb_traffic_analyzer
2
3
.\"    Author: [see the "AUTHOR" section]
3
 
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4
 
.\"      Date: 10/29/2009
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 01/18/2010
5
6
.\"    Manual: System Administration tools
6
7
.\"    Source: Samba 3.4
7
8
.\"  Language: English
8
9
.\"
9
 
.TH "SMB_TRAFFIC_ANALYZER" "8" "10/29/2009" "Samba 3\&.4" "System Administration tools"
10
 
.\" -----------------------------------------------------------------
11
 
.\" * (re)Define some macros
12
 
.\" -----------------------------------------------------------------
13
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
 
.\" toupper - uppercase a string (locale-aware)
15
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
 
.de toupper
17
 
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18
 
\\$*
19
 
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20
 
..
21
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
 
.\" SH-xref - format a cross-reference to an SH section
23
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
 
.de SH-xref
25
 
.ie n \{\
26
 
.\}
27
 
.toupper \\$*
28
 
.el \{\
29
 
\\$*
30
 
.\}
31
 
..
32
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
 
.\" SH - level-one heading that works better for non-TTY output
34
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
 
.de1 SH
36
 
.if t \{\
37
 
.sp 1
38
 
.\}
39
 
.sp \\n[PD]u
40
 
.nr an-level 1
41
 
.set-an-margin
42
 
.nr an-prevailing-indent \\n[IN]
43
 
.fi
44
 
.in \\n[an-margin]u
45
 
.ti 0
46
 
.HTML-TAG ".NH \\n[an-level]"
47
 
.it 1 an-trap
48
 
.nr an-no-space-flag 1
49
 
.nr an-break-flag 1
50
 
.ps +3
51
 
.ft B
52
 
.ne (2v + 1u)
53
 
.ie n \{\
54
 
.\" if n (TTY output), use uppercase
55
 
.toupper \\$*
56
 
.\}
57
 
.el \{\
58
 
.nr an-break-flag 0
59
 
.\" if not n (not TTY), use normal case (not uppercase)
60
 
\\$1
61
 
.in \\n[an-margin]u
62
 
.ti 0
63
 
.\" if not n (not TTY), put a border/line under subheading
64
 
.sp -.6
65
 
\l'\n(.lu'
66
 
.\}
67
 
..
68
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69
 
.\" SS - level-two heading that works better for non-TTY output
70
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
 
.de1 SS
72
 
.sp \\n[PD]u
73
 
.nr an-level 1
74
 
.set-an-margin
75
 
.nr an-prevailing-indent \\n[IN]
76
 
.fi
77
 
.in \\n[IN]u
78
 
.ti \\n[SN]u
79
 
.it 1 an-trap
80
 
.nr an-no-space-flag 1
81
 
.nr an-break-flag 1
82
 
.ps \\n[PS-SS]u
83
 
.ps +2
84
 
.ft B
85
 
.ne (2v + 1u)
86
 
.if \\n[.$] \&\\$*
87
 
..
88
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89
 
.\" BB/BE - put background/screen (filled box) around block of text
90
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
 
.de BB
92
 
.if t \{\
93
 
.sp -.5
94
 
.br
95
 
.in +2n
96
 
.ll -2n
97
 
.gcolor red
98
 
.di BX
99
 
.\}
100
 
..
101
 
.de EB
102
 
.if t \{\
103
 
.if "\\$2"adjust-for-leading-newline" \{\
104
 
.sp -1
105
 
.\}
106
 
.br
107
 
.di
108
 
.in
109
 
.ll
110
 
.gcolor
111
 
.nr BW \\n(.lu-\\n(.i
112
 
.nr BH \\n(dn+.5v
113
 
.ne \\n(BHu+.5v
114
 
.ie "\\$2"adjust-for-leading-newline" \{\
115
 
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
116
 
.\}
117
 
.el \{\
118
 
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119
 
.\}
120
 
.in 0
121
 
.sp -.5v
122
 
.nf
123
 
.BX
124
 
.in
125
 
.sp .5v
126
 
.fi
127
 
.\}
128
 
..
129
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
 
.\" BM/EM - put colored marker in margin next to block of text
131
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
 
.de BM
133
 
.if t \{\
134
 
.br
135
 
.ll -2n
136
 
.gcolor red
137
 
.di BX
138
 
.\}
139
 
..
140
 
.de EM
141
 
.if t \{\
142
 
.br
143
 
.di
144
 
.ll
145
 
.gcolor
146
 
.nr BH \\n(dn
147
 
.ne \\n(BHu
148
 
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
149
 
.in 0
150
 
.nf
151
 
.BX
152
 
.in
153
 
.fi
154
 
.\}
155
 
..
 
10
.TH "SMB_TRAFFIC_ANALYZER" "8" "01/18/2010" "Samba 3\&.4" "System Administration tools"
156
11
.\" -----------------------------------------------------------------
157
12
.\" * set default formatting
158
13
.\" -----------------------------------------------------------------
163
18
.\" -----------------------------------------------------------------
164
19
.\" * MAIN CONTENT STARTS HERE *
165
20
.\" -----------------------------------------------------------------
166
 
.SH "Name"
 
21
.SH "NAME"
167
22
vfs_smb_traffic_analyzer \- log Samba VFS read and write operations through a socket to a helper application
168
 
.SH "Synopsis"
169
 
.fam C
 
23
.SH "SYNOPSIS"
170
24
.HP \w'\ 'u
171
 
\FCvfs objects = smb_traffic_analyzer\F[]
172
 
.fam
 
25
vfs objects = smb_traffic_analyzer
173
26
.SH "DESCRIPTION"
174
27
.PP
175
28
This VFS module is part of the
177
30
suite\&.
178
31
.PP
179
32
The
180
 
\FCvfs_smb_traffic_analyzer\F[]
 
33
vfs_smb_traffic_analyzer
181
34
VFS module logs client write and read operations on a Samba server and sends this data over a socket to a helper program, which feeds a SQL database\&. More information on the helper programs can be obtained from the homepage of the project at: http://holger123\&.wordpress\&.com/smb\-traffic\-analyzer/
182
35
.PP
183
 
\FCvfs_smb_traffic_analyzer\F[]
 
36
vfs_smb_traffic_analyzer
184
37
currently is aware of the following VFS operations:
185
38
.RS 4
186
39
write
195
48
pread
196
49
.RE
197
50
.PP
198
 
\FCvfs_smb_traffic_analyzer\F[]
 
51
vfs_smb_traffic_analyzer
199
52
sends the following data in a fixed format seperated by a comma through either an internet or a unix domain socket:
200
53
.sp
201
54
.if n \{\
202
55
.RS 4
203
56
.\}
204
 
.fam C
205
 
.ps -1
206
57
.nf
207
 
.if t \{\
208
 
.sp -1
209
 
.\}
210
 
.BB lightgray adjust-for-leading-newline
211
 
.sp -1
212
 
 
213
58
        BYTES|USER|DOMAIN|READ/WRITE|SHARE|FILENAME|TIMESTAMP
214
59
        
215
 
.EB lightgray adjust-for-leading-newline
216
 
.if t \{\
217
 
.sp 1
218
 
.\}
219
60
.fi
220
 
.fam
221
 
.ps +1
222
61
.if n \{\
223
62
.RE
224
63
.\}
233
72
.sp -1
234
73
.IP \(bu 2.3
235
74
.\}
236
 
\FCBYTES\F[]
 
75
BYTES
237
76
\- the length in bytes of the VFS operation
238
77
.RE
239
78
.sp
245
84
.sp -1
246
85
.IP \(bu 2.3
247
86
.\}
248
 
\FCUSER\F[]
 
87
USER
249
88
\- the user who initiated the operation
250
89
.RE
251
90
.sp
257
96
.sp -1
258
97
.IP \(bu 2.3
259
98
.\}
260
 
\FCDOMAIN\F[]
 
99
DOMAIN
261
100
\- the domain of the user
262
101
.RE
263
102
.sp
269
108
.sp -1
270
109
.IP \(bu 2.3
271
110
.\}
272
 
\FCREAD/WRITE\F[]
 
111
READ/WRITE
273
112
\- either "W" for a write operation or "R" for read
274
113
.RE
275
114
.sp
281
120
.sp -1
282
121
.IP \(bu 2.3
283
122
.\}
284
 
\FCSHARE\F[]
 
123
SHARE
285
124
\- the name of the share on which the VFS operation occured
286
125
.RE
287
126
.sp
293
132
.sp -1
294
133
.IP \(bu 2.3
295
134
.\}
296
 
\FCFILENAME\F[]
 
135
FILENAME
297
136
\- the name of the file that was used by the VFS operation
298
137
.RE
299
138
.sp
305
144
.sp -1
306
145
.IP \(bu 2.3
307
146
.\}
308
 
\FCTIMESTAMP\F[]
 
147
TIMESTAMP
309
148
\- a timestamp, formatted as "yyyy\-mm\-dd hh\-mm\-ss\&.ms" indicating when the VFS operation occured
310
149
.sp
311
150
.RE
344
183
.if n \{\
345
184
.RS 4
346
185
.\}
347
 
.fam C
348
 
.ps -1
349
186
.nf
350
 
.if t \{\
351
 
.sp -1
352
 
.\}
353
 
.BB lightgray adjust-for-leading-newline
354
 
.sp -1
355
 
 
356
187
        \fI[example_share]\fR
357
188
        \m[blue]\fBpath = /data/example\fR\m[]
358
189
        \m[blue]\fBvfs objects = smb_traffic_analyzer\fR\m[]
359
190
        \m[blue]\fBsmb_traffic_analyzer:mode = unix_domain_socket\fR\m[]
360
191
        
361
 
.EB lightgray adjust-for-leading-newline
362
 
.if t \{\
363
 
.sp 1
364
 
.\}
365
192
.fi
366
 
.fam
367
 
.ps +1
368
193
.if n \{\
369
194
.RE
370
195
.\}
374
199
.if n \{\
375
200
.RS 4
376
201
.\}
377
 
.fam C
378
 
.ps -1
379
202
.nf
380
 
.if t \{\
381
 
.sp -1
382
 
.\}
383
 
.BB lightgray adjust-for-leading-newline
384
 
.sp -1
385
 
 
386
203
        \fI[example_share]\fR
387
204
        \m[blue]\fBpath = /data/example\fR\m[]
388
205
        \m[blue]\fBvfs objects = smb_traffic_analyzer\fR\m[]
389
206
        \m[blue]\fBsmb_traffic_analyzer:host = examplehost\fR\m[]
390
207
        \m[blue]\fBsmb_traffic_analyzer:port = 3491\fR\m[]
391
208
        
392
 
.EB lightgray adjust-for-leading-newline
393
 
.if t \{\
394
 
.sp 1
395
 
.\}
396
209
.fi
397
 
.fam
398
 
.ps +1
399
210
.if n \{\
400
211
.RE
401
212
.\}
405
216
.if n \{\
406
217
.RS 4
407
218
.\}
408
 
.fam C
409
 
.ps -1
410
219
.nf
411
 
.if t \{\
412
 
.sp -1
413
 
.\}
414
 
.BB lightgray adjust-for-leading-newline
415
 
.sp -1
416
 
 
417
220
        \fI[example_share]\fR
418
221
        \m[blue]\fBpath = /data/example\fR\m[]
419
222
        \m[blue]\fBvfs objects = smb_traffic_analyzer\fR\m[]
421
224
        \m[blue]\fBsmb_traffic_analyzer:port = 3491\fR\m[]
422
225
        \m[blue]\fBsmb_traffic_analyzer:anonymize_prefix = User\fR\m[]
423
226
        
424
 
.EB lightgray adjust-for-leading-newline
425
 
.if t \{\
426
 
.sp 1
427
 
.\}
428
227
.fi
429
 
.fam
430
 
.ps +1
431
228
.if n \{\
432
229
.RE
433
230
.\}