xref: /third_party/cups-filters/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>COPYING</licensefile>
        <policylist>
            <policy name="projectPolicy" desc="">
				<policyitem type="compatibility" name="GPL-2.0" path="filter/.*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="imagetoraster独立进程使用,依赖的cups和cupsfilters动态链接库"/>
				<policyitem type="compatibility" name="GPL-2.0" path="cupsfilters/.*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="cupsfilters动态链接库, imagetoraster独立进程使用"/>
				<policyitem type="compatibility" name="GPL-2.0+" path="mime/cupsfilters.types" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="配置文件, 被cups服务读取"/>
				<policyitem type="compatibility" name="LGPLStyleLicense" path="cupsfilters/ipp.h" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="cupsfilters动态链接库, imagetoraster独立进程使用"/>
				<policyitem type="compatibility" name="LGPLStyleLicense" path="cupsfilters/ipp.c" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc="cupsfilters动态链接库, imagetoraster独立进程使用"/>
			</policy>
        </policylist>
		<licensematcherlist>
			<licensematcher name="GPL-2.0" desc="" >
				<licensetext name="
				*   These coded instructions, statements, and computer programs are the
				*   property of Apple Inc. and are protected by Federal copyright
				*   law.  Distribution and use rights are outlined in the file &quot;COPYING&quot;
				*   which should have been included with this file.
				" desc=""/>
				<licensetext name="
				PDF file output routines.
				" desc=""/>
				<licensetext name="
				# License: GPL-2.0
				" desc=""/>
			</licensematcher>
			<licensematcher name="LGPL-2.1+" desc="" >
				<licensetext name="
				under the terms of the GNU Lesser General Public License as
				" desc=""/>
			</licensematcher>
			<licensematcher name="MIT License" desc="" >
				<licensetext name="
				// MIT Licensed.
				" desc=""/>
			</licensematcher>
		</licensematcherlist>
        <filefilterlist>
            <filefilter name="defaultFilter" desc="Files not to check">
				<filteritem type="filename" name="ChangeLog" desc="修改日志信息"/>
				<filteritem type="filename" name="COPYING" desc="COPYING信息"/>
				<filteritem type="filename" name="AUTHORS" desc="作者信息"/>
				<filteritem type="filename" name="INSTALL" desc="安装指导信息"/>
				<filteritem type="filename" name="install-sh" desc="安装脚本信息"/>
				<filteritem type="filename" name="Makefile.am" desc="编译脚本信息"/>
            </filefilter>
            <filefilter name="copyrightPolicyFilter" desc="Files not to check">
				<filteritem type="filepath" name="cupsfilters/.*" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="filter/.*" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="backend/.*" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="mime/.*" desc="驱动配置文件，只读，没有修改"/>
				<filteritem type="filepath" name="drv/.*" desc="没有使用"/>
				<filteritem type="filepath" name="banners/.*" desc="没有使用"/>
				<filteritem type="filepath" name="utils/.*" desc="没有使用"/>
				<filteritem type="filepath" name="fontembed/.*" desc="没有使用"/>
				<filteritem type="filepath" name="ppd/.*" desc="没有使用"/>
				<filteritem type="filepath" name="m4/.*" desc="没有使用"/>
				<filteritem type="filepath" name="data/.*" desc="没有使用"/>
				<filteritem type="filepath" name="scripting/.*" desc="没有使用"/>
				<filteritem type="filepath" name="charset/.*" desc="没有使用"/>
				<filteritem type="filepath" name="autogen.sh" desc="没有使用"/>
				<filteritem type="filepath" name="configure.ac" desc="没有使用"/>
				<filteritem type="filepath" name="ln-srf" desc="没有使用"/>
            </filefilter>
			<filefilter name="defaultPolicyFilter" desc="Files not to check">
				<filteritem type="filepath" name="cupsfilters/.*" desc="除了单列，其它动态链接方式使用"/>
				<filteritem type="filepath" name="fontembed/.*" desc="没有使用"/>
				<filteritem type="filepath" name="banners/.*" desc="没有使用"/>
				<filteritem type="filepath" name="drv/.*" desc="没有使用"/>
				<filteritem type="filepath" name="mime/.*" desc="除了单列，其它驱动配置文件只读，没有修改"/>
				<filteritem type="filepath" name="charset/.*" desc="没有使用"/>
				<filteritem type="filepath" name="autogen.sh" desc="没有使用"/>
				<filteritem type="filepath" name="configure.ac" desc="没有使用"/>
				<filteritem type="filepath" name="ln-srf" desc="没有使用"/>
				<filteritem type="filepath" name="filter/.*" desc="除了单列，其它都没有参与编译使用"/>
				<filteritem type="filepath" name="filter/common.c" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="filter/common.h" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="filter/imagetoraster.c" desc="动态链接方式使用"/>
				<filteritem type="filepath" name="cupsfilters/testdriver.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="cupsfilters/testimage.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="pcl-common.h" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="mime/cupsfilters-ghostscript.convs" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="cupsfilters/testrgb.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="cupsfilters/testdither.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="cupsfilters/testcmyk.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="mime/cupsfilters-mupdf.convs" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="mime/cupsfilters-poppler.convs" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="implicitclass.c" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="scripting/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="backend/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="ppd/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="data/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="utils/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="m4/.*" desc="代码没有参与编译"/>
				<filteritem type="filepath" name="data/unclassified.ps" desc="PostScript文件, 没有参与编译"/>
				<filteritem type="filepath" name="data/confidential.ps" desc="PostScript文件, 没有参与编译"/>
				<filteritem type="filepath" name="data/topsecret.ps" desc="PostScript文件, 没有参与编译"/>
				<filteritem type="filepath" name="data/classified.ps" desc="PostScript文件, 没有参与编译"/>
				<filteritem type="filepath" name="data/standard.ps" desc="PostScript文件, 没有参与编译"/>
				<filteritem type="filepath" name="data/secret.ps" desc="PostScript文件, 没有参与编译"/>
			</filefilter>
            <filefilter name="binaryFileTypePolicyFilter" desc="二进制文件校验策略的过滤条件" >
				<filteritem type="filepath" name="data/confidential.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/unclassified.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/default-testpage.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/default.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="drv/cupsfilters.drv" desc="drv驱动示例文件"/>
				<filteritem type="filepath" name="data/form_english.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/form_english_in.odt" desc="odt文档文件"/>
				<filteritem type="filepath" name="drv/generic-brf.drv" desc="drv驱动示例文件"/>
				<filteritem type="filepath" name="data/form_russian.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="drv/generic-ubrl.drv" desc="drv驱动示例文件"/>
				<filteritem type="filepath" name="data/form_russian_in.odt" desc="odt文档文件"/>
				<filteritem type="filepath" name="drv/indexv3.drv" desc="drv驱动示例文件"/>
				<filteritem type="filepath" name="drv/indexv4.drv" desc="drv驱动示例文件"/>
				<filteritem type="filepath" name="data/secret.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/standard.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/classified.pdf" desc="pdf文件"/>
				<filteritem type="filepath" name="data/topsecret.pdf" desc="pdf文件"/>
			</filefilter>
        </filefilterlist>
    </oatconfig>
</configuration>