111 lines
6.5 KiB
XML
111 lines
6.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!-- Copyright (c) 2021 Huawei Device Co., Ltd.
|
||
|
||
Licensed under the Apache License, Version 2.0 (the "License");
|
||
you may not use this file except in compliance with the License.
|
||
You may obtain a copy of the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing, software
|
||
distributed under the License is distributed on an "AS IS" BASIS,
|
||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
See the License for the specific language governing permissions and
|
||
limitations under the License.
|
||
-->
|
||
<!-- OAT(OSS Audit Tool) configuration guide:
|
||
basedir: Root dir, the basedir + project path is the real source file location.
|
||
licensefile:
|
||
1.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.
|
||
|
||
tasklist(only for batch mode):
|
||
1. task: Define oat check thread, each task will start a new thread.
|
||
2. task name: Only an name, no practical effect.
|
||
3. task policy: Default policy for projects under this task, this field is required and the specified policy must defined in policylist.
|
||
4. task filter: Default filefilter for projects under this task, this field is required and the specified filefilter must defined in filefilterlist.
|
||
5. task project: Projects to be checked, the path field define the source root dir of the project.
|
||
|
||
|
||
policyList:
|
||
1. policy: All policyitems will be merged to default OAT.xml rules, the name of policy doesn't affect OAT check process.
|
||
2. policyitem: The fields type, name, path, desc is required, and the fields rule, group, filefilter is optional,the default value is:
|
||
<policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/>
|
||
3. policyitem type:
|
||
"compatibility" is used to check license compatibility in the specified path;
|
||
"license" is used to check source license header in the specified path;
|
||
"copyright" is used to check source copyright header in the specified path;
|
||
"import" is used to check source dependency in the specified path, such as import ... ,include ...
|
||
"filetype" is used to check file type in the specified path, supported file types: archive, binary
|
||
"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
|
||
|
||
4. 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.
|
||
5. 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.
|
||
6. 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.
|
||
7. policyitem filefilter: Used to bind filefilter which define filter rules.
|
||
8. filefilter: Filter rules, the type filename is used to filter file name, the type filepath is used to filter file path.
|
||
|
||
Note:If the text contains special characters, please escape them according to the following rules:
|
||
" == >
|
||
& == >
|
||
' == >
|
||
< == >
|
||
> == >
|
||
-->
|
||
<configuration>
|
||
<oatconfig>
|
||
<licensefile>COPYING</licensefile>
|
||
<policylist>
|
||
<policy name="projectPolicy" desc="">
|
||
<policyitem type="compatibility" name="The curl license" path=".*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc=""/>
|
||
<policyitem type="compatibility" name="curl" path=".*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc=""/>
|
||
<policyitem type="compatibility" name="ISC License" path=".*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc=""/>
|
||
</policy>
|
||
</policylist>
|
||
<licensematcherlist>
|
||
<licensematcher name="The curl license" desc="If the scanning result is InvalidLicense, you can define matching rules here. Note that quotation marks must be escaped.">
|
||
<licensetext name="
|
||
* This software is licensed as described in the file COPYING, which
|
||
* you should have received as part of this distribution. The terms
|
||
* are also available at https://curl.se/docs/copyright.html.
|
||
*
|
||
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
* copies of the Software, and permit persons to whom the Software is
|
||
* furnished to do so, under the terms of the COPYING file.
|
||
" desc=""/>
|
||
<licensetext name="
|
||
* Permission to use, copy, modify, and distribute this software for any
|
||
* purpose with or without fee is hereby granted, provided that the above
|
||
* copyright notice and this permission notice appear in all copies.
|
||
*
|
||
* THE SOFTWARE IS PROVIDED >AS IS> AND INTERNET SOFTWARE CONSORTIUM
|
||
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
|
||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
|
||
* INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
|
||
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
|
||
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
|
||
* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
" desc=""/>
|
||
</licensematcher>
|
||
</licensematcherlist>
|
||
<filefilterlist>
|
||
<filefilter name="defaultPolicyFilter" desc="Filters for compatibility，license header policies">
|
||
<filteritem type="filename" name="macos_main.cpp" desc=""/>
|
||
<filteritem type="filename" name="test17" desc=""/>
|
||
<filteritem type="filename" name="*.sh" desc=""/>
|
||
<filteritem type="filename" name="*.bat" desc=""/>
|
||
<filteritem type="filename" name="*.cmd" desc=""/>
|
||
<filteritem type="filename" name="*.m4" desc=""/>
|
||
<filteritem type="filepath" name="docs/.*" desc=""/>S
|
||
</filefilter>
|
||
<filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies">
|
||
</filefilter>
|
||
<filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies">
|
||
</filefilter>
|
||
<filefilter name="binaryFileTypePolicyFilter" desc="File not used">
|
||
<filteritem type="filepath" name="tests/.*" desc=""/>
|
||
</filefilter>
|
||
</filefilterlist>
|
||
</oatconfig>
|
||
</configuration>
|