123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127 |
- <?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.
- Notes:
- This is project config file for OpenHarmony OSS Audit Tool, if you have any questions or concerns, please email chenyaxun.
- -->
- <!-- 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>sdk_liteos/license/LICENSE</licensefile>
- <policylist>
- <policy name="projectPolicy" desc="">
- <policyitem type="copyright" name="Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED." path=".*" desc="HiSilicon copyright"/>
- <policyitem type="copyright" name="Copyright (c) 2021 HiSilicon (Shanghai) Technologies CO., LIMITED." path=".*" desc="HiSilicon copyright"/>
- <policyitem type="copyright" name="Copyright (C) 2020 Hisilicon (Shanghai) Technologies Co., Ltd. All rights reserved." path=".*" desc="HiSilicon copyright"/>
- <policyitem type="license" name="BSD-3-Clause" path=".*" desc="HiSilicon copyright"/>
- <policyitem type="license" name="EndUserLicenseAgreement" path=".*" desc="HiSilicon copyright"/>
- </policy>
- </policylist>
- <filefilterlist>
- <filefilter name="defaultFilter" desc="Files not to check">
- <!--filteritem type="filename" name="*.lds|*.pod"/-->
- <!--filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/-->
- </filefilter>
- <filefilter name="defaultPolicyFilter" desc="Filters for compatibility,license header policies">
- <!--filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/-->
- <filteritem type="filepath" name="sdk_liteos/platform/os/.*" desc="liteos"/>
- <filteritem type="filepath" name="sdk_liteos/third_party/.*" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="hi3861_adapter/.*" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/components/iperf2/include/iperf.h" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.mk" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.sh" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.gni" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.xml" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.cfg" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.csv" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.S|*.gn" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.txt" desc="Temp files"/>
- </filefilter>
- <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies" >
- <filteritem type="filepath" name="sdk_liteos/platform/os/.*" desc="liteos"/>
- <filteritem type="filepath" name="sdk_liteos/third_party/.*" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="hi3861_adapter/.*" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/components/iperf2/include/iperf.h" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.mk" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.sh" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.gni" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.xml" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.cfg" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.png" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.csv" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.S|*.gn" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.txt" desc="Temp files"/>
- </filefilter>
- <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies" >
- <!--filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/-->
- </filefilter>
- <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies" >
- </filefilter>
- <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies" >
- <!--filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/-->
- </filefilter>
- <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies" >
- <filteritem type="filepath" name="sdk_liteos/build/libs/.*.a" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/build/libs/.*.o" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filename" name="*.exe|*.bin|*.png" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/tools/nvtool/tools/nv/cdbm" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/tools/lzma_tool/lzma_tool" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/build/scripts/ota_builder" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/tools/sign_tool/sign_tool" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/tools/nvtool/nv_builder" desc="Describe the reason for filtering scan results"/>
- <filteritem type="filepath" name="sdk_liteos/third_party/u-boot-v2019.07/u-boot-v2019.07.tar.gz" desc="Describe the reason for filtering scan results"/>
- </filefilter>
- </filefilterlist>
- </oatconfig>
- </configuration>
|