xref: /third_party/cups/OAT.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.

	 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:
" == &gt;
& == &gt;
' == &gt;
< == &gt;
> == &gt;
-->
<configuration>
    <oatconfig>
        <licensefile>LICENSE</licensefile>
        <policylist>
            <policy name="projectPolicy" desc="">
                <policyitem type="compatibility" name="zlib-acknowledgement" path="cups-2.4.0/cups/md5.c" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="zlib License"/>
                <policyitem type="compatibility" name="zlib-acknowledgement" path="cups-2.4.0/cups/md5-internal.h" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="zlib License"/>
            </policy>
        </policylist>
		<licensematcherlist>
			<licensematcher name="Apache License v2.0" desc="" >
				<licensetext name="
                * Licensed under Apache License v2.0.  See the file &quot;LICENSE&quot; for more
                * information.
				" desc=""/>
				<licensetext name="
                dnl Licensed under Apache License v2.0.  See the file &quot;LICENSE&quot; for more
                dnl information.
				" desc=""/>
            </licensematcher>
		</licensematcherlist>
        <filefilterlist>
            <filefilter name="defaultFilter" desc="Files not to check">
				<filteritem type="filepath" name="cups.spec" desc="上游更新记录说明"/>
				<filteritem type="filepath" name="cups-2.4.0/vcnet/regex/COPYRIGHT" desc="COPYING信息"/>
				<filteritem type="filepath" name="cups-2.4.0/install-sh" desc="安装脚本信息"/>
				<filteritem type="filepath" name="cups-2.4.0/backend/usb-darwin.c" desc="没有编译使用"/>
				<filteritem type="filepath" name="cups-2.4.0/filter/spec-ppd.shtml" desc="没有编译使用"/>
				<filteritem type="filepath" name="cups-2.4.0/filter/ppd-compiler.shtml" desc="没有编译使用"/>
				<filteritem type="filepath" name="cups-2.4.0/config.sub" desc="没有编译使用"/>
				<filteritem type="filepath" name="cups-2.4.0/config.guess" desc="没有编译使用"/>
				<filteritem type="filepath" name="cups-2.4.0/NOTICE" desc="上游notice信息"/>
				<filteritem type="filepath" name="cups-2.4.0/backend/pseudo" desc="没有编译使用"/>
            </filefilter>
            <filefilter name="binaryFileTypePolicyFilter" desc="二进制文件校验策略的过滤条件" >
				<filteritem type="filepath" name="cups-2.4.0/doc/images/.*" desc="示例图片文件，未使用"/>
				<filteritem type="filepath" name="cups-2.4.0/examples/.*" desc="示例文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/desktop/.*" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/tools/.*" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/cups/cupspm-icon.png" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/cups/cupspm.opacity" desc="opacity文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/cups/cupspm.png" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/doc/apple-touch-icon.png" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0-source.tar.gz" desc="源码压缩包"/>
                <filteritem type="filepath" name="cups-2.4.0/ppdc/sample.drv" desc="drv示例驱动文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/scheduler/libcupsmime.exp" desc=".exp文件，未使用"/>
                <filteritem type="filepath" name="cupsprinter.png" desc="图片文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/cgi-bin/libcupscgi.exp" desc=".exp文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/doc/help/cupspm.epub" desc="电子书文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/ppdc/foo.drv" desc="drv示例驱动文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/cgi-bin/multipart.dat" desc="脚本文件，未使用"/>
                <filteritem type="filepath" name="cups-2.4.0/test/4.1-requests.test" desc="test文件，未使用"/>

			</filefilter>
        </filefilterlist>
    </oatconfig>
</configuration>