aboutsummaryrefslogtreecommitdiffstats
path: root/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/provider/CachedPublicKeyRing.java
blob: 7be8cdd3bb020ff3e10e96cf941f4bd744a5243a (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * Copyright (C) 2014 Dominik Schürmann <dominik@dominikschuermann.de>
 * Copyright (C) 2014 Vincent Breitmoser <v.breitmoser@mugenguild.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sufficientlysecure.keychain.provider;

import android.database.Cursor;
import android.net.Uri;

import org.sufficientlysecure.keychain.Constants;
import org.sufficientlysecure.keychain.pgp.CanonicalizedSecretKey.SecretKeyType;
import org.sufficientlysecure.keychain.pgp.KeyRing;
import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException;
import org.sufficientlysecure.keychain.provider.KeychainContract.KeyRings;
import org.sufficientlysecure.keychain.provider.KeychainContract.Keys;
import org.sufficientlysecure.keychain.provider.ProviderHelper.NotFoundException;
import org.sufficientlysecure.keychain.util.Log;

/**
 * This implementation of KeyRing provides a cached view of PublicKeyRing
 * objects based on database queries exclusively.
 * <p/>
 * This class should be used where only few points of data but no actual
 * cryptographic operations are required about a PublicKeyRing which is already
 * in the database.  This happens commonly in UI code, where parsing of a PGP
 * key for examination would be a very expensive operation.
 * <p/>
 * Each getter method is implemented using a more or less expensive database
 * query, while object construction is (almost) free. A common pattern is
 * mProviderHelper.getCachedKeyRing(uri).getterMethod()
 * <p/>
 * TODO Ensure that the values returned here always match the ones returned by
 * the parsed KeyRing!
 */
public class CachedPublicKeyRing extends KeyRing {

    final ProviderHelper mProviderHelper;
    final Uri mUri;

    public CachedPublicKeyRing(ProviderHelper providerHelper, Uri uri) {
        mProviderHelper = providerHelper;
        mUri = uri;
    }

    @Override
    public long getMasterKeyId() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.MASTER_KEY_ID, ProviderHelper.FIELD_TYPE_INTEGER);
        return (Long) data;
    }

    /**
     * Find the master key id related to a given query. The id will either be extracted from the
     * query, which should work for all specific /key_rings/ queries, or will be queried if it can't.
     */
    public long extractOrGetMasterKeyId() throws NotFoundException {
        // try extracting from the uri first
        String firstSegment = mUri.getPathSegments().get(1);
        if (!firstSegment.equals("find")) try {
            return Long.parseLong(firstSegment);
        } catch (NumberFormatException e) {
            // didn't work? oh well.
            Log.d(Constants.TAG, "Couldn't get masterKeyId from URI, querying...");
        }
        return getMasterKeyId();
    }

    public byte[] getFingerprint() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.FINGERPRINT, ProviderHelper.FIELD_TYPE_BLOB);
        return (byte[]) data;
    }

    @Override
    public String getPrimaryUserId() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.USER_ID,
                ProviderHelper.FIELD_TYPE_STRING);
        return (String) data;
    }

    public String getPrimaryUserIdWithFallback() throws NotFoundException {
        return getPrimaryUserId();
    }

    @Override
    public boolean isRevoked() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.IS_REVOKED,
                ProviderHelper.FIELD_TYPE_INTEGER);
        return (Long) data > 0;
    }

    @Override
    public boolean canCertify() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.HAS_CERTIFY,
                ProviderHelper.FIELD_TYPE_NULL);
        return !((Boolean) data);
    }

    @Override
    public long getEncryptId() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeyRings.HAS_ENCRYPT,
                ProviderHelper.FIELD_TYPE_INTEGER);
        return (Long) data;
    }

    @Override
    public boolean hasEncrypt() throws NotFoundException {
        return getEncryptId() != 0;
    }

    /**
     * Returns the key id which should be used for signing.
     * <p/>
     * This method returns keys which are actually available (ie. secret available, and not stripped,
     * revoked, or expired), hence only works on keyrings where a secret key is available!
     */
    public long getSecretSignId() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeyRings.HAS_SIGN,
                ProviderHelper.FIELD_TYPE_INTEGER);
        return (Long) data;
    }

    @Override
    public int getVerified() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.VERIFIED,
                ProviderHelper.FIELD_TYPE_INTEGER);
        return (Integer) data;
    }

    public boolean hasAnySecret() throws NotFoundException {
        Object data = mProviderHelper.getGenericData(mUri,
                KeychainContract.KeyRings.HAS_ANY_SECRET,
                ProviderHelper.FIELD_TYPE_INTEGER);
        return (Long) data > 0;
    }

    private Cursor getSubkeys() throws NotFoundException {
        Uri keysUri = KeychainContract.Keys.buildKeysUri(extractOrGetMasterKeyId());
        return mProviderHelper.getContentResolver().query(keysUri, null, null, null, null);
    }

    public SecretKeyType getSecretKeyType(long keyId) throws NotFoundException {
        Object data = mProviderHelper.getGenericData(Keys.buildKeysUri(mUri),
                KeyRings.HAS_SECRET,
                ProviderHelper.FIELD_TYPE_INTEGER,
                KeyRings.KEY_ID + " = " + Long.toString(keyId));
        return SecretKeyType.fromNum(((Long) data).intValue());
    }

}