6f9b0174046d72d8bb5a90f8ddfbc69b88d8ee01
[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 dlog (Version 1.0)
36
37 Compiling for multiple architectures
38 *************************
39 DEVICE(arm) - use test/scripts/PrepareForDevice.sh
40 EMULATOR(x86) - use test/scripts/PrepareForEmul.sh
41
42 1. Tizen Content Screening Framework [SUPPORTED ON DEVICE]
43 ============================================
44 (export script . ./test/scripts/PrepareForDevice.sh)
45
46   1.1 Building the framework library for device:
47   ======================
48   - cd framework (change your current folder to 'framework')
49   - make clean; 
50   - make
51   - The library can be found at 'lib/libsecfw.so'
52
53   1.2 Testing Tizen content screening framework library
54   ======================
55   - cd test (change your current folder to 'test')
56   - Connect your test device (not support emulator)
57   - chmod +x ./scripts/MfeToDevice.sh (optional)
58   - ./scripts/MfeToDevice.sh
59   - sdb -d shell (make sure you have enough privilege to write or read all folders under /opt/)
60   - cd /tmp/tcs_test
61   - chmod +x ./Test.sh (optional)
62   - ./Test.sh
63
64   1.3 Test Tizen Web Protection framework library
65   ======================
66   - cd test (change your current folder to 'test')
67   - Connect your test device (not support emulator)
68   - chmod +x ./scripts/MfeWPToDevice.sh (optional)
69   - ./scripts/MfeWPToDevice.sh
70   - sdb shell (make sure you have enough privilege to write or read all folders under /opt/)
71   - cd /tmp/twp_test
72   - chmod +x ./Test.sh (optional)
73   - ./Test.sh
74
75 2. Tizen Security Services [SUPPORTED ON EMULATOR]
76 ============================================
77 (export script . ./test/scripts/PrepareForEmul.sh)
78 (cd framework/ (change your current folder to 'framework'))
79   
80   2.1 Building the framework library for emulator:
81   ======================
82   - make clean; 
83   - make
84   - The library can be found at 'lib/libsecfw.so'
85