• 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                <filteritem type="filepath" name="src/utils/iwre.c" desc="the header of the file is not license" />
70                <filteritem type="filepath" name="src/utils/iwavl.h" desc="CC0 1.0 Universal" />
71                <filteritem type="filepath" name="src/utils/iwavl.c" desc="CC0 1.0 Universal" />
72            </filefilter>
73            <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies">
74            </filefilter>
75            <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies">
76            </filefilter>
77            <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies">
78            </filefilter>
79            <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies">
80                <filteritem type="filepath" name=".*" desc="Describe the reason for filtering scan results"/>
81            </filefilter>
82            <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies">
83                <filteritem type="filename" name=".png" desc="the picture of iowow"/>
84            </filefilter>
85        </filefilterlist>
86        <licensematcherlist>
87            <licensematcher name="BSD-3-Clause" desc="">
88                <licensetext name="
89                A C-program for MT19937, with initialization improved 2002/1/26.
90                Coded by Takuji Nishimura and Makoto Matsumoto.
91
92                Before using, initialize the state by using init_genrand(seed)
93                or init_by_array(init_key, key_length).
94
95                Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
96                All rights reserved.
97                Copyright (C) 2005, Mutsuo Saito,
98                All rights reserved.
99
100                Redistribution and use in source and binary forms, with or without
101                modification, are permitted provided that the following conditions
102                are met:
103
104                    1. Redistributions of source code must retain the above copyright
105                        notice, this list of conditions and the following disclaimer.
106
107                    2. Redistributions in binary form must reproduce the above copyright
108                        notice, this list of conditions and the following disclaimer in the
109                        documentation and/or other materials provided with the distribution.
110
111                    3. The names of its contributors may not be used to endorse or promote
112                        products derived from this software without specific prior written
113                        permission.
114
115                THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
116                &gt;AS IS&gt; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
117                LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
118                A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
119                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
120                EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
121                PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
122                PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
123                LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
124                NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
125                SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
126
127
128                Any feedback is very welcome.
129                http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
130                email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)"
131                desc=""/>
132            </licensematcher>
133            <licensematcher name="BSD-3-Clause" desc="">
134                <licensetext name="
135                Copyright (c) 2011, Willem-Hendrik Thiart
136                Copyright (c) 2012-2020 Softmotions Ltd &gt; info@softmotions.com &gt;
137                All rights reserved.
138
139                Redistribution and use in source and binary forms, with or without
140                modification, are permitted provided that the following conditions are met:
141                    * Redistributions of source code must retain the above copyright
142                    notice, this list of conditions and the following disclaimer.
143                    * Redistributions in binary form must reproduce the above copyright
144                    notice, this list of conditions and the following disclaimer in the
145                    documentation and/or other materials provided with the distribution.
146                    * The names of its contributors may not be used to endorse or promote
147                    products derived from this software without specific prior written
148                    permission.
149
150                THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &gt; AS IS &gt; AND
151                ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
152                WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
153                DISCLAIMED. IN NO EVENT SHALL WILLEM-HENDRIK THIART BE LIABLE FOR ANY
154                DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
155                (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
156                LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
157                ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
158                (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
159                SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
160                desc=""/>
161            </licensematcher>
162            <licensematcher name="BSD-3-Clause" desc="">
163                <licensetext name="
164                Copyright (c) 2011, Willem-Hendrik Thiart
165                Copyright (c) 2012-2022 Softmotions Ltd &gt; info@softmotions.com &gt;
166                All rights reserved.
167
168                Redistribution and use in source and binary forms, with or without
169                modification, are permitted provided that the following conditions are met:
170                * Redistributions of source code must retain the above copyright
171                    notice, this list of conditions and the following disclaimer.
172                * Redistributions in binary form must reproduce the above copyright
173                    notice, this list of conditions and the following disclaimer in the
174                    documentation and/or other materials provided with the distribution.
175                * The names of its contributors may not be used to endorse or promote
176                    products derived from this software without specific prior written
177                    permission.
178
179                THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &gt; AS IS &gt; AND
180                ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
181                WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
182                DISCLAIMED. IN NO EVENT SHALL WILLEM-HENDRIK THIART BE LIABLE FOR ANY
183                DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
184                (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
185                LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
186                ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
187                (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
188                SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
189                desc=""/>
190            </licensematcher>
191            <licensematcher name="Khronos License" desc="">
192                <licensetext name="
193                Copyright (c) 2014 by Ian Piumarta
194                All rights reserved.
195
196                Permission is hereby granted, free of charge, to any person obtaining a
197                copy of this software and associated documentation files (the &gt;Software&gt;),
198                to deal in the Software without restriction, including without limitation
199                the rights to use, copy, modify, merge, publish, distribute, and/or sell
200                copies of the Software, and to permit persons to whom the Software is
201                furnished to do so, provided that the above copyright notice(s) and this
202                permission notice appear in all copies of the Software.  Acknowledgement
203                of the use of this Software in supporting documentation would be
204                appreciated but is not required.
205
206                THE SOFTWARE IS PROVIDED &gt;AS IS&gt;.  USE ENTIRELY AT YOUR OWN RISK."
207                desc=""/>
208            </licensematcher>
209            <licensematcher name="CC0 1.0 Universal" desc="">
210                <licensetext name="
211                Written in 2014-2016 by Eric Biggers &gt;ebiggers3@gmail.com&gt;
212
213                To the extent possible under law, the author(s) have dedicated all copyright
214                and related and neighboring rights to this software to the public domain
215                worldwide via the Creative Commons Zero 1.0 Universal Public Domain
216                Dedication (the &gt;CC0&gt;).
217
218                This software is distributed in the hope that it will be useful, but WITHOUT
219                ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
220                FOR A PARTICULAR PURPOSE. See the CC0 for more details.
221
222                You should have received a copy of the CC0 along with this software; if not
223                see &gt;http://creativecommons.org/publicdomain/zero/1.0/&gt;."
224                desc=""/>
225            </licensematcher>
226        </licensematcherlist>
227    </oatconfig>
228</configuration>