aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/modules/codesign/android.qbs
blob: be96d42dea377ecbb92ecf6ae65492c1a89a32e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/****************************************************************************
**
** Copyright (C) 2021 Raphaël Cotty <raphael.cotty@gmail.com>
** Contact: http://www.qt.io/licensing
**
** This file is part of the Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

import qbs
import qbs.Environment
import qbs.File
import qbs.FileInfo
import qbs.ModUtils
import qbs.Probes
import "codesign.js" as CodeSign

CodeSignModule {
    condition: qbs.targetOS.contains("android")
    priority: 1
    enableCodeSigning: true

    property bool useApksigner: true
    property path apksignerFilePath

    Probes.JdkProbe {
        id: jdk
        environmentPaths: (jdkPath ? [jdkPath] : []).concat(base)
    }
    property string jdkPath: jdk.path
    property string jarsignerFilePath: FileInfo.joinPaths(jdkPath, "bin", jarsignerName)
    property string jarsignerName: "jarsigner"
    property string keytoolFilePath: FileInfo.joinPaths(jdkPath, "bin", keytoolName)
    property string keytoolName: "keytool"

    property string debugKeystorePath: FileInfo.joinPaths(
                                           Environment.getEnv(qbs.hostOS.contains("windows")
                                                              ? "USERPROFILE" : "HOME"),
                                           ".android", "debug.keystore")
    readonly property string debugKeystorePassword: "android"
    readonly property string debugPassword: "android"
    readonly property string debugKeyAlias: "androiddebugkey"

    property string keystorePath: debugKeystorePath
    property string keystorePassword: debugKeystorePassword
    property string keyPassword: debugPassword
    property string keyAlias: debugKeyAlias

    // Private property set by the Android.sdk module
    property string _packageName

    Rule {
        condition: useApksigner
        inputs: ["android.package_unsigned"]
        Artifact {
            filePath: product.codesign._packageName
            fileTags: "android.package"
        }
        prepare: CodeSign.signApkPackage.apply(this, arguments)
    }

    Rule {
        condition: !useApksigner
        inputs: ["android.package_unsigned"]
        Artifact {
            filePath: product.codesign._packageName
            fileTags: "android.package"
        }
        prepare: CodeSign.signAabPackage.apply(this, arguments)
    }

    validate: {
        // Typically there is a debug keystore in ~/.android/debug.keystore which gets created
        // by the native build tools the first time a build is done. However, we don't want to
        // create it ourselves, because writing to a location outside the qbs build directory is
        // both polluting and has the potential for race conditions. So we'll instruct the user what
        // to do.
        if (keystorePath === debugKeystorePath && !File.exists(debugKeystorePath)) {
            throw ModUtils.ModuleError("Could not find an Android debug keystore at " +
                  codesign.debugKeystorePath + ". " +
                  "If you are developing for Android on this machine for the first time and " +
                  "have never built an application using the native Gradle / Android Studio " +
                  "tooling, this is normal. You must create the debug keystore now using the " +
                  "following command, in order to continue:\n\n" +
                  CodeSign.createDebugKeyStoreCommandString(codesign.keytoolFilePath,
                                                            codesign.debugKeystorePath,
                                                            codesign.debugKeystorePassword,
                                                            codesign.debugPassword,
                                                            codesign.debugKeyAlias) +
                  "\n\n" +
                  "See the following URL for more information: " +
                  "https://developer.android.com/studio/publish/app-signing.html#debug-mode");
        }
    }
}