Certificate Transparency 项目使用教程

Certificate Transparency 项目使用教程

certificatetransparency Certificate transparency for Android and JVM 项目地址: https://gitcode.com/gh_mirrors/cer/certificatetransparency

1. 项目目录结构及介绍

certificatetransparency/
├── ThreatDragonModels/
│   └── certificate-transparency-android/
├── buildSrc/
├── certificatetransparency-android/
├── certificatetransparency/
├── docs/
├── gradle/
├── sampleapp/
├── .editorconfig
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.md
├── NOTICE.md
├── README.md
├── build.gradle.kts
├── code-of-conduct.md
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle.kts

目录结构介绍

• ThreatDragonModels/: 包含用于威胁建模的文件，特别是针对 Android 的证书透明性。
• buildSrc/: 包含构建脚本的源代码。
• certificatetransparency-android/: 包含 Android 平台的证书透明性实现。
• certificatetransparency/: 包含证书透明性的核心实现。
• docs/: 包含项目的文档文件。
• gradle/: 包含 Gradle 构建工具的配置文件。
• sampleapp/: 包含示例应用程序的代码。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• CONTRIBUTING.md: 贡献指南，说明如何为项目做出贡献。
• LICENSE.md: 项目许可证文件，说明项目的开源许可证。
• NOTICE.md: 项目通知文件，包含项目使用的第三方库和资源。
• README.md: 项目自述文件，包含项目的基本信息和使用说明。
• build.gradle.kts: 项目的 Gradle 构建脚本。
• code-of-conduct.md: 行为准则文件，说明项目社区的行为规范。
• gradle.properties: Gradle 属性文件，包含 Gradle 构建工具的配置属性。
• gradlew: Gradle 包装器脚本，用于在不同平台上运行 Gradle 构建。
• gradlew.bat: Gradle 包装器脚本的 Windows 批处理版本。
• settings.gradle.kts: Gradle 设置脚本，用于配置多项目构建。

2. 项目启动文件介绍

项目的启动文件主要集中在 certificatetransparency-android/ 和 certificatetransparency/ 目录中。以下是一些关键文件的介绍：

certificatetransparency-android/

• SampleApplication.kt: 这是 Android 应用程序的启动文件。它包含了应用程序的初始化代码，包括证书透明性提供者的安装和配置。

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        installCertificateTransparencyProvider {
            // 配置日志记录器
            logger = BasicAndroidCTLogger(BuildConfig.DEBUG)
            // 配置磁盘缓存
            diskCache = AndroidDiskCache(applicationContext)
            // 排除特定域名
            excludeDomain("*appmattus.com")
            // 包含特定子域名
            includeDomain("allowed.appmattus.com")
        }
    }
}

certificatetransparency/

• CertificateTransparency.kt: 这是证书透明性的核心实现文件。它包含了证书透明性的主要逻辑和功能。

3. 项目的配置文件介绍

项目的配置文件主要集中在根目录和 gradle/ 目录中。以下是一些关键配置文件的介绍：

根目录

• build.gradle.kts: 这是项目的 Gradle 构建脚本。它包含了项目的依赖管理、插件配置和其他构建相关的设置。

plugins {
    id("com.android.application")
    kotlin("android")
    kotlin("android.extensions")
}

dependencies {
    implementation("com.appmattus:certificatetransparency-android:<latest-version>")
}

• gradle.properties: 这是 Gradle 属性文件，包含了 Gradle 构建工具的配置属性。

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
android.useAndroidX=true
android.enableJetifier=true

gradle/

• wrapper/gradle-wrapper.properties: 这是 Gradle 包装器的配置文件，指定了 Gradle 的版本和下载地址。

distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

通过以上配置文件，可以对项目进行构建、依赖管理和运行环境的配置。

certificatetransparency Certificate transparency for Android and JVM 项目地址: https://gitcode.com/gh_mirrors/cer/certificatetransparency