OSEmu - ein MicroEmu, klein und simpel

OSEmu
======

Here is a working sample for a simple (micro) emu.
It includes the basic needed cs357x (camd35 UDP) functionality, and is very simple and compact.


Build: 
======

- Put a SoftCam.Key file into the source code directory (for example from skystar.org).
  Note: This does not apply for Mac OSX and Android, SoftCam.Key cannot be integrated on these systems at the moment. 
  
- Run `make` to compile OSEmu.

  Info: If you want to cross-compile OSEmu search for the "simpleemu" script by gorgone.


Run:
====

- (optional) OSEmu does not require, but will make use of "SoftCam.Key" if available. 
             "SoftCam.Key" is searched in:
              - /var/keys
              - The folder specified with the "-c <folder>" option.
              

- You may use the program with the following options:

  -a <user>:<password> (set the cs357x user and password) [REQUIRED]
  -p <portnumber> (set the cs357x port) [REQUIRED]
  -c <folder> (set the folder where SoftCam.Key is searched)
  -b (start OSEmu in background/daemon mode)
  -v (log debug information)
  -l <logfile> (write logs to this file)
  -e (enable emm au) 
      - Viaccess3: Needs M0 key; oscam clients must be version r10584 or newer, and the OSEmu reader must have set "emmcache = 1,1,2,1".
      - Irdeto2: Needs M0 and M3/4/5/6 key
      - PowerVU: Needs AU key
  -L (only allow local connections from localhost)
  -i (show OSEmu version info and exit)
  -r <stream source port>:<relay port> (enables stream relay server)
  
  Examples:
    /usr/bin/OSEmu -a user:password -p 11000 -b
    /usr/bin/OSEmu -a user:password -p 11000 -b -c /usr/keys -l /var/log/osemu.log -e
    /usr/bin/OSEmu -a user:password -p 11000 -b -r 8001:17999

OSCam reader config for OSEmu
=============================

[reader]
label                         = OSEmu
protocol                      = cs357x
device                        = 127.0.0.1,11000
user                          = user
password                      = password
caid                          = 0D00,0D02,090F,0500,1801,0604,2600,FFFF
ident                         = 0D00:000000,000004,000010,000014,000020,0000C0,0000C4,0000C8,0000CC;0D02:000000,00008C,0000A0,0000A4,0000A8;090F:000000;0500:000000,030B00,023800,021110,007400,007800;1801:000000,007301,001101;0604:000000;2600:000000;FFFF:000000;
group                         = 1
emmcache                      = 1,1,2,1


BISS/ConstCW config
===================

Syntax for keys in SoftCam.Key: (key number can be '00' or '01')
F <service id><ecm pid> <key number> <key>

Example:

    service id: 2222
    ecm pid: 1111
    key: 0102030405060708

    F 22221111 00 0102030405060708
    
Important:
    The correct ecm pid is only available when using oscam dvbapi.
    For example:
            oscam (dvbapi) <-> OSEmu
            oscam (dvbapi) <-> oscam <-> OSEmu
            
    When using another client like cccam, the ecm pid seen by OSEmu will always be '1FFF'
    For example:
            cccam <-> oscam <-> OSEmu
            cccam <-> OSEmu
    In this case the above example key line needs to be changed to:
    F 22221FFF 00 0102030405060708


    When using cccam clients for BISS/ConstCW create a second reader with no ident line:
    
[reader]
label                         = OSEmu-BISS
protocol                      = cs357x
device                        = 127.0.0.1,11000
user                          = user
password                      = password
caid                          = 2600,FFFF
group                         = 2

PowerVU config
==============

Keys in SoftCam.Key:
    P <srvid> <nb> <key>
    example:
    P 1234 01 11223344556677

    AU keys:
    P <srvid> <UA> <key>
    example:
    P 1234 11223344 11223344556677

For PowerVU the Stream Relay must be used:

IMPORTANT:
    The stream relay needs a fast CPU. Not every STB is fast enough.
    If you encounter problems like suttering, likely your CPU is too slow.

    For OSEmu it is required that the "Include ECM in http streams" setting is enabled.
    If your image supports it (openpli, openatv), you can find it here:
    OpenWebif -> Settings -> Customize
    
    If your image does not support it, the only option is to use oscam-emu.
    OSEmu's stream relay will NOT work without "Include ECM in http streams".
    
    Switch to oscam-emu if the option is not available.
    

Channel Config:
1. Go to the OpenWebif and click on the "Stream" button for the channel you want to add.
2. Download and save the .m3u file.
3. Open the .m3u file with a text edior and get the stream link. It looks like this:
    http://stb:8001/1:0:19:0123:3EF:1:C00000:0:0:0:
4. Replace the port (8001) with the relay port (default: 17999) and the host name ("stb") with 127.0.0.1
    [URL]https://127.0.0.1:17999/1:0:19:0123:3EF:1:C00000:0:0:0[/URL]:
5. Add the new stream link to your channel list (for example with DreamBoxEdit)

IMPORTANT:
    Do NOT use the correct Transponder ID/Network ID/Namespace for the stream link.
    Use Transponder ID: "11", Network ID: "22" and Namespace: "33".
    Set Service Type to "1", and enter the correct Service ID for the channel.

Note: 
    When using DreamBoxEdit:
    
    A. Go to the list in the middle "Bouquet details".
    B. Right click on a channel, select "IPTV and other streaming services", select "Add".
    C. Select "DVB/TS".
    D. Chosse a name and use the new stream link as URL.
    E. Use the "Service ID" of the original channel. You can find it in the left list ("Services")
    

Drecrypt2 info:
===============

OSemu cannot support Drecrypt2 because no client will send the overcrypt EMMs to it.
Support for Drecryp2 is available in oscam-emu.

OSCam-emu: Open Source Conditional Access Module Emulator
=========================================================

OSCam-emu is an Oscam addon module to include emulator support and other functionality that collides with the goal of the original oscam developers.

This patch creates a virtual card reader which is configured automatically.
You may save the default reader configuration with the webif and then modify it to your own liking.

Key file ("SoftCam.Key"):
OSCam-emu does not require, but will make use of "SoftCam.Key" if available.
"SoftCam.Key" is searched in the oscam config folder (where oscam.conf is located) and also in "/var/keys".

You may use OSEmu instead and add it as a reader to your plain oscam server.
OSEmu can be found at [URL]https://github.com/oscam-emu/OSEmu[/URL]

Supported systems
=================

Currently only the following crypto systems are available:
 - Cryptoworks
 - SoftNDS
 - Viaccess 1/2/3
 - Nagra 2
 - Irdeto 2
 - Biss (Mode 1) [Note: only 1 key possible for a sid/pid combination, use the oscam constcw reader if you need more]
 - PowerVU (via Stream Relay)
 - Drecrypt2 *experimental, most likely some fixes are needed*

All of these are basically working, but far from complete so anyone filling in blanks is welcome...


TODO
====

Work has to be done on the following items:
 - Add other encryption systems


Version history
===============

OSCam-emu history is accessible through GitHub commits at:
   [URL]https://github.com/oscam-emu/oscam-emu[/URL]


Building OSCam-emu from source
==============================

 - Get the lastest oscam sources from SVN:
    svn checkout [URL]http://www.streamboard.tv/svn/oscam/trunk[/URL] oscam-svn

 - Save the oscam-emu.patch file:
    wget [URL]https://github.com/oscam-emu/oscam-emu/raw/master/oscam-emu.patch[/URL]

 - Go to oscam-svn directory:
    cd oscam-svn

 - Patch the source with the EMU patch:
    patch -p0 < ../oscam-emu.patch
    
 - OR: Instead of 'patch', you may also use 'svn patch':
    svn patch ../oscam-emu.patch
    
 - Put a SoftCam.Key file into the oscam-svn directory (for example from skystar.org)
   Note: This does not apply for Mac OSX and Android, SoftCam.Key cannot be integrated on these systems at the moment.
  
 - Run `./config.sh -g` to choose the features you want.

 - Run `make` to compile OSCam.


OSCam dvbapi config
===================

If dvbapi is activated, the "delayer" option is forced to have a value of at least 60.
This is to avoid freezes/crashes because of too fast ecm responses.


Help and Support
================

You may visit our issues system for filling in bug reports regarding EMU issues.
   [URL]https://github.com/oscam-emu/oscam-emu/issues[/URL]

Configuration wiki:
   [URL]http://www.streamboard.tv/wiki/index.php/OSCam[/URL]


BISS/ConstCW config
===================

Syntax for keys in SoftCam.Key: (key number can be '00' or '01')
F <service id><ecm pid> <key number> <key>

Example:

    service id: 2222
    ecm pid: 1111
    key: 0102030405060708

    F 22221111 00 0102030405060708
    
Important:
    The correct ecm pid is only available when using oscam dvbapi.
    For example:
            oscam (dvbapi) <-> OSEmu
            oscam (dvbapi) <-> oscam <-> OSEmu
            
    When using another client like cccam, the ecm pid seen by OSEmu will always be '1FFF'
    For example:
            cccam <-> oscam <-> OSEmu
            cccam <-> OSEmu
    In this case the above example key line needs to be changed to:
    F 22221FFF 00 0102030405060708
    
PowerVU config
==============

Keys in SoftCam.Key:
    P <srvid> <nb> <key>
    example:
    P 1234 01 11223344556677

    AU keys:
    P <srvid> <UA> <key>
    example:
    P 1234 11223344 11223344556677

For PowerVU the Stream Relay must be used:

IMPORTANT:
    The stream relay needs a fast CPU. Not every STB is fast enough.
    If you cannot fix stuttering with the following guide, likely your CPU is 
    too slow.

    For best performance, the "Include ECM in http streams" setting must be enabled.
    If your image supports it (openpli, openatv), you can find it here:
    OpenWebif -> Settings -> Customize
    
    If the setting is not available, you may need to adjust the "ECM fix delay"
    setting in oscam webif (Config -> Stream Relay).
    Increase/Lower it until there is no stuttering.

    When using VU+ devices, make sure to use the latest drivers (June 2015), if 
    you encounter any problems.

Channel Config:
1. Go to the OpenWebif and click on the "Stream" button for the channel you want to add.
2. Download and save the .m3u file.
3. Open the .m3u file with a text edior and get the stream link. It looks like this:
    [URL]https://stb:8001/1:0:19:0123:3EF:1:C00000:0:0:0:[/URL]
4. Replace the port (8001) with the relay port (default: 17999) and the host name ("stb") with 127.0.0.1
    [URL]https://127.0.0.1:17999/1:0:19:0123:3EF:1:C00000:0:0:0[/URL]:
5. Add the new stream link to your channel list (for example with DreamBoxEdit)

IMPORTANT:
    Do NOT use the correct Transponder ID/Network ID/Namespace for the stream link.
    Use Transponder ID: "11", Network ID: "22" and Namespace: "33".
    Set Service Type to "1", and enter the correct Service ID for the channel.

Note: 
    When using DreamBoxEdit:
    
    A. Go to the list in the middle "Bouquet details".
    B. Right click on a channel, select "IPTV and other streaming services", select "Add".
    C. Select "DVB/TS".
    D. Chosse a name and use the new stream link as URL.
    E. Use the "Service ID" of the original channel. You can find it in the left list ("Services")
    

Drecrypt2 config:
=================

IMPORTANT:
    Drecrypt2 support is experimental at the moment.
    Most likely you will encounter problems, which need to be fixed first.

Keys in SoftCam.Key:

D <caid><provider> <key type><key index> <key>
example:
D 4AE1FF AA01 112233445566778899AABBCCDDEEFF0011223344556677889900AABBCCDDEEFF

AU keys:
D <caid><provider> MK<key type><key index> <key>
example:
D 4AE1FF MKAA01 112233445566778899AABBCCDDEEFF0011223344556677889900AABBCCDDEEFF