• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8"?>
2<!-- Copyright (c) 2021 Huawei Device Co., Ltd.
3     Licensed under the Apache License, Version 2.0 (the "License");
4     you may not use this file except in compliance with the License.
5     You may obtain a copy of the License at
6
7          http://www.apache.org/licenses/LICENSE-2.0
8
9     Unless required by applicable law or agreed to in writing, software
10     distributed under the License is distributed on an "AS IS" BASIS,
11     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12     See the License for the specific language governing permissions and
13     limitations under the License.
14-->
15<!-- Notes:
16     This is project config file for OpenHarmony OSS Audit Tool, if you have any questions or concerns, please email chenyaxun.
17-->
18<!-- OAT(OSS Audit Tool) configuration guide:
19basedir: Root dir, the basedir + project path is the real source file location.
20licensefile:
211.If the project don't have "LICENSE" in root dir, please define all the license files in this project in , OAT will check license files according to this rule.
22
23tasklist(only for batch mode):
241. task: Define oat check thread, each task will start a new thread.
252. task name: Only an name, no practical effect.
263. task policy: Default policy for projects under this task, this field is required and the specified policy must defined in policylist.
274. task filter: Default filefilter for projects under this task, this field is required and the specified filefilter must defined in filefilterlist.
285. task project: Projects to be checked, the path field define the source root dir of the project.
29
30
31policyList:
321. policy: All policyitems will be merged to default OAT.xml rules, the name of policy doesn't affect OAT check process.
332. policyitem: The fields type, name, path, desc is required, and the fields rule, group, filefilter is optional,the default value is:
34<policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/>
353. policyitem type:
36    "compatibility" is used to check license compatibility in the specified path;
37    "license" is used to check source license header in the specified path;
38    "copyright" is used to check source copyright header in the specified path;
39    "import" is used to check source dependency in the specified path, such as import ... ,include ...
40    "filetype" is used to check file type in the specified path, supported file types: archive, binary
41    "filename" is used to check whether the specified file exists in the specified path(support projectroot in default OAT.xml), supported file names: LICENSE, README, README.OpenSource
42
434. policyitem name: This field is used for define the license, copyright, "*" means match all, the "!" prefix means could not match this value. For example, "!GPL" means can not use GPL license.
445. policyitem path: This field is used for define the source file scope to apply this policyitem, the "!" prefix means exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem.
456. policyitem rule and group: These two fields are used together to merge policy results. "may" policyitems in the same group means any one in this group passed, the result will be passed.
467. policyitem filefilter: Used to bind filefilter which define filter rules.
478. filefilter: Filter rules, the type filename is used to filter file name, the type filepath is used to filter file path.
48
49Note:If the text contains special characters, please escape them according to the following rules:
50" == &gt;
51& == &gt;
52' == &gt;
53< == &gt;
54> == &gt;
55-->
56<configuration>
57    <oatconfig>
58        <licensefile></licensefile>
59        <policylist>
60            <policy name="projectPolicy" desc="">
61            </policy>
62        </policylist>
63        <filefilterlist>
64            <filefilter name="defaultFilter" desc="Files not to check">
65            </filefilter>
66            <filefilter name="defaultPolicyFilter" desc="Filters for compatibility,license header policies">
67                <filteritem type="filepath" name="release.sh" desc="the header of the file is not license" />
68                <filteritem type="filepath" name="src/bindings/ejdb2_flutter/ios/ejdb2_flutter.podspec" desc="the header of the file is not license" />
69            </filefilter>
70            <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies">
71            </filefilter>
72            <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies">
73            </filefilter>
74            <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies">
75            </filefilter>
76            <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies">
77                <filteritem type="filepath" name=".*" desc="Describe the reason for filtering scan results"/>
78            </filefilter>
79            <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies">
80                <filteritem type="filename" name=".png" desc="the picture of iowow"/>
81            </filefilter>
82        </filefilterlist>
83        <licensematcherlist>
84            <licensematcher name="BSD-3-Clause" desc="">
85                <licensetext name="
86                A C-program for MT19937, with initialization improved 2002/1/26.
87                Coded by Takuji Nishimura and Makoto Matsumoto.
88
89                Before using, initialize the state by using init_genrand(seed)
90                or init_by_array(init_key, key_length).
91
92                Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
93                All rights reserved.
94                Copyright (C) 2005, Mutsuo Saito,
95                All rights reserved.
96
97                Redistribution and use in source and binary forms, with or without
98                modification, are permitted provided that the following conditions
99                are met:
100
101                    1. Redistributions of source code must retain the above copyright
102                        notice, this list of conditions and the following disclaimer.
103
104                    2. Redistributions in binary form must reproduce the above copyright
105                        notice, this list of conditions and the following disclaimer in the
106                        documentation and/or other materials provided with the distribution.
107
108                    3. The names of its contributors may not be used to endorse or promote
109                        products derived from this software without specific prior written
110                        permission.
111
112                THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
113                &gt;AS IS&gt; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
114                LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
115                A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
116                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
117                EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
118                PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
119                PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
120                LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
121                NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
122                SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
123
124
125                Any feedback is very welcome.
126                http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
127                email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)"
128                desc=""/>
129            </licensematcher>
130            <licensematcher name="BSD-3-Clause" desc="">
131                <licensetext name="
132                Copyright (c) 2011, Willem-Hendrik Thiart
133                Copyright (c) 2012-2020 Softmotions Ltd &gt; info@softmotions.com &gt;
134                All rights reserved.
135
136                Redistribution and use in source and binary forms, with or without
137                modification, are permitted provided that the following conditions are met:
138                    * Redistributions of source code must retain the above copyright
139                    notice, this list of conditions and the following disclaimer.
140                    * Redistributions in binary form must reproduce the above copyright
141                    notice, this list of conditions and the following disclaimer in the
142                    documentation and/or other materials provided with the distribution.
143                    * The names of its contributors may not be used to endorse or promote
144                    products derived from this software without specific prior written
145                    permission.
146
147                THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &gt; AS IS &gt; AND
148                ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
149                WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
150                DISCLAIMED. IN NO EVENT SHALL WILLEM-HENDRIK THIART BE LIABLE FOR ANY
151                DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
152                (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
153                LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
154                ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
155                (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
156                SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
157                desc=""/>
158            </licensematcher>
159        </licensematcherlist>
160    </oatconfig>
161</configuration>