source: trunk/Distribution/doc/man/oscam.server.5@ 1213

Last change on this file since 1213 was 1213, checked in by landlord, 11 years ago

Documentation update: 'boxkey' and 'rsakey' can be used for Irdeto SCs, too.

File size: 7.9 KB
Line 
1.TH oscam.server 5
2.SH NAME
3\fBoscam.server\fR - reader configuration file for OSCam
4.SH SYNOPSIS
5The server configuration file for OSCam contains reader parameters.
6sections in \fBoscam.server\fR are \fIrecurring\fR (more than one reader possible).
7At least one [reader] section is \fIrequired\fR.
8.SH DESCRIPTIONS
9.SS "The [reader] section"
10.PP
11\fBdevice\fP = \fBdevice\fP|\fB<ip|hostname>,<port>[,<lport>]\fP|\fBpcsc\fP
12.RS 3n
13define local or remote reader
14 \fBlport\fP: remapping to local port
15 \fBPCSC\fP: number of PCSC readers, starting with 0
16.RE
17.PP
18\fBkey\fP = \fBDES key\fP
19.RS 3n
20key for newcamd remote reader encryption
21.RE
22.PP
23\fBpassword\fP = \fBpassword\fP
24.RS 3n
25password for remote gbox reader
26.RE
27.PP
28\fBpremium\fP = \fB???\fP
29.RS 3n
30for gbox reader
31.RE
32.PP
33\fBaccount\fP = \fBuser,password\fP
34.RS 3n
35user and password for remote reader
36.RE
37.PP
38\fBpincode\fP = \fBpincode\fP
39.RS 3n
40pincode for Conax and Cryptoworks SCs
41.RE
42.PP
43\fBservices\fP = \fB[!]services[,[!]<services>]...\fP
44.RS 3n
45reader [de]assingment to service group, default=none
46.RE
47.PP
48\fBinactivitytimeout\fP = \fBminutes\fP
49.RS 3n
50inactivity timeout for newcamd reader, default:none
51.RE
52.PP
53\fBreconnecttimeout\fP = \fBminutes\fP
54.RS 3n
55TCP reconnect, if missing answers, default:none
56.RE
57.PP
58\fBdisableserverfilter\fP = \fB0\fP|\fB1\fP
59.RS 3n
601 = ignore \fBcaid\fP and \fBident\fP settings of reader due faulty clients, default=0
61.RE
62.PP
63\fBlabel\fP = \fBname\fP
64.RS 3n
65name for reader, \fIrequired\fR
66.RE
67.PP
68\fBfallback\fP = \fB0\fP|\fB1\fP
69.RS 3n
701 = define reader as fallback, standard and fallback reader must have the same group, default:0
71.RE
72.PP
73\fBlogport\fP = \fB0\fP|\fBport\fP
74.RS 3n
75camd3 reader logport, camd3 UDP must be activated, only works if there's no camd3 cascading, 0=disabled, default=0
76.RE
77.PP
78\fBcaid\fP = \fBCAID[&<mask>][,CAID[&<mask>]]...\fP
79.RS 3n
80define CAID for reader, some protocols only support one CAID, default:\fBmask\fP=FFFF
81
82example: CAID=0100,0200&FFDF
83.RE
84.PP
85\fBboxid\fP = \fBNDS box ID\fP
86.RS 3n
87NDS receiver box id
88.RE
89.PP
90\fBaeskey\fP = \fBAES key\fP
91.RS 3n
92AES key for Viaccess SCs
93.RE
94.PP
95\fBdetect\fP = \fBCD\fP|\fBDSR\fP|\fBCTS\fP|\fBRING\fP|\fBNONE\fP|\fBgpio[2-7]\fP
96.RS 3n
97status detect of card (NONE = no detection), default:CD
98.RE
99.PP
100\fBcardmhz\fP = \fBmhz\fP
101.RS 3n
102set standard SC frequency in units of 10 kHz, for Irdeto SC set to 600, refer to OVERCLOCKING, default:357
103.RE
104.PP
105\fBmhz\fP = \fBfrequency\fP
106.RS 3n
107set reader frequency in units of 10 kHz, if \fBmhz\fP > \fBcardmhz\fP you are in overclocking mode,
108refer to OVERCLOCKING, default:357
109.RE
110.PP
111\fBprotocol\fP = \fBreader protocol\fP
112.RS 3n
113reader protocol, \fIrequired\fR:
114 \fBmouse\fP
115 \fBsmartreader\fP
116 \fBinternal\fP
117 \fBserial\fP
118 \fBcamd35\fP|\fBcs357x\fP
119 \fBcs378x\fP
120 \fBgbox\fP
121 \fBnewcamd\fP|\fBnewcamd525\fP
122 \fBnewcamd524\fP
123 \fBcccam\fP
124 \fBradegast\fP
125 \fBpcsc\fP
126.RE
127.PP
128\fBcccversion\fP = \fB<main version>.<version>.<sub version>\fP
129.RS 3n
130define CCcam version, default:none
131
132exmaple: cccversion = 1.2.34
133.RE
134.PP
135\fBcccbuild\fP = \fB<4-digit number>\fP
136.RS 3n
137define CCcam build, default:none
138
139exmaple: cccbuild = 5678
140.RE
141.PP
142\fBcccmaxhop\fP = \fBhops\fP
143.RS 3n
144define CCcam maximum SC distance, default:10
145.RE
146.PP
147\fBident\fP = \fB<CAID>:<ident>[,ident]...[,<CAID>:<ident>[,ident]...]...\fP
148.RS 3n
149define CAID and ident for reader
150
151exmaple: ident = 0100:123456,234567;0200:345678,456789
152.RE
153.PP
154\fBprovid\fP = \fBID\fP
155.RS 3n
156define provider ID for reader
157.RE
158.PP
159\fBclass\fP = \fB[!]class[,[!]class]...\fP
160.RS 3n
161define class in hex for reader
162
163example: class = 01,02,!1b,!2b
164.RE
165.PP
166\fBchid\fP = \fBCAID:ChID\fP
167.RS 3n
168define Irdeto ChID for reader
169
170example: chid = 0100:12
171.RE
172.PP
173\fBshowcls\fP = \fBquantity\fP
174.RS 3n
175number of classes subscriptions to show for Viaccess SCs, default=10
176.RE
177.PP
178\fBmaxqlen\fP = \fBsize\fP
179.RS 3n
180size of request queue for reader, default:128
181.RE
182.PP
183\fBgroup\fP = \fBgroupname\fP
184.RS 3n
185reader assingment to group, \fIrequired\fR
186.RE
187.PP
188\fBemmcache\fP = \fBusecache,rewrite,logging\fP
189.RS 3n
190set EMM cache of local reader:
191 \fBusecache\fP = \fB0\fP|\fB1\fP 1=enable EMM chaching, default:0
192 \fBrewrite\fP = determines how often one and the same EMM is written
193 \fBlogging\fP = \fB0\fP = log errors only
194 \fB1\fP = log all EMMs except the double EMMs
195 \fB2\fP = log all EMMs
196.RE
197.PP
198\fBblocknano\fP = \fBnano[,nano]...\fP|\fPall\fP
199.RS 3n
200list of EMM-nanos to block (in hex w/o 0x) or all EMM-nanos, only valid for physical readers, default:none
201
202 example: blocknano = 45,93,7a,ff
203 blocknano = all
204.RE
205.PP
206\fBsavenano\fP = \fBnano[,nano]....\fP|\fPall\fP
207.RS 3n
208list of EMM-nanos to save (in hex w/o 0x) or all EMM-nanos, only valid for physical readers, default:none
209
210 example: savenano = 45,93,7a,ff
211 savenano = all
212.RE
213.PP
214\fBreadnano\fP = \fB[path]filename\fP
215.RS 3n
216write file (usually a copy of a file saved by savenano) to your smartcard, if no path is specified, the specified file is searched for in the configuration directory, only valid for physical readers, default:none
217
218 example: readnano = write.emm
219 readnano = /var/oscam/write.emm
220.RE
221.PP
222\fBn3_rsakey\fP|\fBrsakey\fP = \fBRSA key\fP
223.RS 3n
224RSA key for Nagravision SCs / CAM key data for Irdeto SCs
225.RE
226.PP
227\fBn3_boxkey\fP|\fBboxkey\fP = \fBbox key\fP
228.RS 3n
229box key for Nagravision SCs / CAM key for Irdeto SCs
230.RE
231.PP
232\fBtiger_rsakey\fP = \fBRSA key\fP
233.RS 3n
234RSA key for Tiger Nagravision SCs
235.RE
236.PP
237\fBtiger_ideakey\fP = \fBIDEA key\fP
238.RS 3n
239IDEA key for Tiger Nagravision SCs
240.RE
241.SH OVERCLOCKING
242.TP 3n
243\(bu
244Dreambox and other internal readers
245
246For Dreambox and other internal readers the highest possible
247clockrate will be auto detected. The \fBmhz\fR parameter will be ignored.
248.TP 3n
249\(bu
250Phoenix / Smartmouse reader
251
252Overclocking does not work with Windows and Mac OS X.
253Set \fBmhz\fR equivalent to the frequency of the reader.
254OSCam can not set the frequency of the reader.
255.TP 3n
256\(bu
257Smargo Smartreader+
258
259Set the reader frequency with the native Smargo Smartreader+ tool (srp_tools).
260Do not set \fBmhz\fR and \fBcardmhz\fR.
261.PP
262OSCam tries to set the baudrate automatically.
263A standard serial port has limited baudrate settings, so SC overclocking might not work.
264When using a serial reader the best way for overclocking is connecting it to a FTDI based USB to serial port adapter.
265
266If overclocking does not work, verify the effective baudrate in the logfile.
267If it deviates too much from the requested baudrate, the SC will not be recognized (no ATR)
268and the value for \fBmhz\fR should be adjusted again.
269The higher the baudrate, the more accurate the effective baudrate can be.
270.SH EXAMPLES
271.TP 3n
272\(bu
273serial mouse compatible reader
274
275 [reader]
276 label = myserialmousereader
277 detect = cd
278 protocol = mouse
279 device = /dev/ttyS1
280 group = 1
281 caid = 0100
282 services = myservice,!thisservice
283.TP 3n
284\(bu
285USB mouse compatible reader
286
287 [reader]
288 label = myusbmousereader
289 detect = cd
290 protocol = mouse
291 device = /dev/ttyUSB0
292 aeskey = 0102030405060708090a0b0c0d0e0f10
293 group = 2
294 caid = 0200
295.TP 3n
296\(bu
297camd 3.78x reader
298
299 [reader]
300 label = mycamd378xreader
301 protocol = cs378x
302 device = 192.168.0.1,1234
303 account = user,password
304 group = 3
305.TP 3n
306\(bu
307newcamd reader
308
309 [reader]
310 label = mynewcamdreader
311 protocol = newcamd
312 key = 0102030405060708091011121314
313 device = 192.168.0.2,2345
314 account = user,password
315 group = 4
316.TP 3n
317\(bu
318CCcam reader
319
320 [reader]
321 label = mycccamreader
322 protocol = cccam
323 device = 192.168.0.3,3456
324 account = user,password
325 group = 5
326 caid = 0300,0400,0500
327 cccversion = 1.2.3
328 cccbuild = 4567
329.TP 3n
330\(bu
331PCSC reader
332
333 [reader]
334 label = mypcscreader
335 protocol = pcsc
336 device = 0
337 aeskey = 0102030405060708090a0b0c0d0e0f10
338 group = 6
339 caid = 0600
340.SH "SEE ALSO"
341\fBoscam\fR(1), \fBoscam.conf\fR(5), \fBoscam.user\fR(5), \fBoscam.srvid\fR(5), \fBoscam.guess\fR(5), \fBoscam.cert\fR(5), \fBoscam.services\fR(5), \fBoscam.ird\fR(5), \fBoscam.ac\fR(5)
Note: See TracBrowser for help on using the repository browser.