Revert "Remove TPCS and TWPServer features"
[platform/upstream/csf-framework.git] / README
1 #
2 #  Copyright (c) 2014, McAfee, Inc.
3 #  
4 #  All rights reserved.
5 #  
6 #  Redistribution and use in source and binary forms, with or without modification,
7 #  are permitted provided that the following conditions are met:
8 #  
9 #  Redistributions of source code must retain the above copyright notice, this list
10 #  of conditions and the following disclaimer.
11 #  
12 #  Redistributions in binary form must reproduce the above copyright notice, this
13 #  list of conditions and the following disclaimer in the documentation and/or other
14 #  materials provided with the distribution.
15 #  
16 #  Neither the name of McAfee, Inc. nor the names of its contributors may be used
17 #  to endorse or promote products derived from this software without specific prior
18 #  written permission.
19 #  
20 #  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 #  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 #  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 #  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24 #  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 #  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 #  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 #  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
28 #  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29 #  OF THE POSSIBILITY OF SUCH DAMAGE.
30 #
31
32 Install following packages to the rootstrap
33 and setup the build environment
34 *************************
35 dbus (Version 1.6.4)
36 dbus-glib (Version 0.100)
37 glib (Version 2.32.3)
38 gobject (Version 2.32.3)
39 dlog (Version 1.0)
40
41 Compiling for multiple architectures
42 *************************
43 DEVICE(arm) - use test/scripts/PrepareForDevice.sh
44 EMULATOR(x86) - use test/scripts/PrepareForEmul.sh
45
46 1. Tizen Content Screening Framework [SUPPORTED ON DEVICE]
47 ============================================
48 (export script . ./test/scripts/PrepareForDevice.sh)
49
50   1.1 Building the framework library for device:
51   ======================
52   - cd framework (change your current folder to 'framework')
53   - make clean; 
54   - make
55   - The library can be found at 'lib/libsecfw.so'
56
57   1.2 Testing Tizen content screening framework library
58   ======================
59   - cd test (change your current folder to 'test')
60   - Connect your test device (not support emulator)
61   - chmod +x ./scripts/MfeToDevice.sh (optional)
62   - ./scripts/MfeToDevice.sh
63   - sdb -d shell (make sure you have enough privilege to write or read all folders under /opt/)
64   - cd /tmp/tcs_test
65   - chmod +x ./Test.sh (optional)
66   - ./Test.sh
67
68   1.3 Test Tizen Web Protection framework library
69   ======================
70   - cd test (change your current folder to 'test')
71   - Connect your test device (not support emulator)
72   - chmod +x ./scripts/MfeWPToDevice.sh (optional)
73   - ./scripts/MfeWPToDevice.sh
74   - sdb shell (make sure you have enough privilege to write or read all folders under /opt/)
75   - cd /tmp/twp_test
76   - chmod +x ./Test.sh (optional)
77   - ./Test.sh
78
79 2. Tizen Security Services [SUPPORTED ON EMULATOR]
80 ============================================
81 (export script . ./test/scripts/PrepareForEmul.sh)
82 (cd framework/ (change your current folder to 'framework'))
83   
84   2.1 Building the framework library for emulator:
85   ======================
86   - make clean; 
87   - make
88   - The library can be found at 'lib/libsecfw.so'
89
90   2.2 Building IPC Client library
91   ======================
92   - make -f Makefile_channel_client clean
93   - make -f Makefile_channel_client
94   - The library can be found at 'lib/libscclient.so'
95
96   2.3 Building IPC Server library
97   ======================
98   - make -f Makefile_channel_server clean;
99   - make -f Makefile_channel_server
100   - The library can be found at 'lib/libscserver.so'
101
102   2.4 Building Plugin control service
103   ======================
104   - make -f Makefile_TPCSSerDaemon clean;
105   - make -f Makefile_TPCSSerDaemon
106   - The binary can be found at 'bin/TPCSSerDaemon'
107
108   2.5 Building Web protection control service
109   ======================
110   - make -f Makefile_TWPSerDaemon clean
111   - make -f Makefile_TWPSerDaemon
112   - The binary can be found at 'bin/TWPSerDaemon'
113
114   2.6 Testing Plugin control service
115   ======================
116   -cd test (change your folder to test)
117   -Start the emulator
118   -chmod +x ./scripts/MfeTPCSSerDaemonToEmul.sh
119   -sdb -e shell (make sure you have enough privilege to write or read all folders under /opt/, /usr/bin/ and /tmp)
120   -cd /usr/bin
121   -chmod +x ./Test.sh
122   - ./Test.sh
123   - ./tpcsserdaemontest
124
125   2.7 Testing Web protection control service
126   ======================
127   -cd test (change your folder to test)
128   -Start the emulator
129   -chmod +x ./scripts/MfeTWPSerDaemonToEmul.sh
130   -sdb -e shell (make sure you have enough privilege to write or read all folders under /opt/, /tmp)
131   -cd /usr/bin
132   -chmod +x ./Test.sh
133   - ./Test.sh
134   - ./twpserdaemontest