open-keychain/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/input/CryptoInputParcel.java

/*
 * Copyright (C) 2015 Dominik Schürmann <dominik@dominikschuermann.de>
 *
 * 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.service.input;

import android.os.Parcel;
import android.os.Parcelable;

import org.sufficientlysecure.keychain.util.ParcelableProxy;
import org.sufficientlysecure.keychain.util.Passphrase;

import java.nio.ByteBuffer;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * This is a base class for the input of crypto operations.
 */
public class CryptoInputParcel implements Parcelable {

    final Date mSignatureTime;
    public Passphrase mPassphrase;
    // used to supply an explicit proxy to operations that require it
    // this is not final so it can be added to an existing CryptoInputParcel
    // (e.g) CertifyOperation with upload might require both passphrase and orbot to be enabled
    private ParcelableProxy mParcelableProxy;

    // specifies whether passphrases should be cached
    public boolean mCachePassphrase = true;

    // this map contains both decrypted session keys and signed hashes to be
    // used in the crypto operation described by this parcel.
    private HashMap<ByteBuffer, byte[]> mCryptoData = new HashMap<>();

    public CryptoInputParcel() {
        mSignatureTime = new Date();
        mPassphrase = null;
        mCachePassphrase = true;
    }

    public CryptoInputParcel(Date signatureTime, Passphrase passphrase) {
        mSignatureTime = signatureTime == null ? new Date() : signatureTime;
        mPassphrase = passphrase;
        mCachePassphrase = true;
    }

    public CryptoInputParcel(Passphrase passphrase) {
        mSignatureTime = new Date();
        mPassphrase = passphrase;
        mCachePassphrase = true;
    }

    public CryptoInputParcel(Date signatureTime) {
        mSignatureTime = signatureTime == null ? new Date() : signatureTime;
        mPassphrase = null;
        mCachePassphrase = true;
    }

    public CryptoInputParcel(ParcelableProxy parcelableProxy) {
        this();
        mParcelableProxy =  parcelableProxy;
    }

    public CryptoInputParcel(boolean cachePassphrase) {
        mSignatureTime = new Date();
        mPassphrase = null;
        mCachePassphrase = cachePassphrase;
    }

    protected CryptoInputParcel(Parcel source) {
        mSignatureTime = new Date(source.readLong());
        mPassphrase = source.readParcelable(getClass().getClassLoader());
        mParcelableProxy = source.readParcelable(getClass().getClassLoader());
        mCachePassphrase = source.readByte() != 0;

        {
            int count = source.readInt();
            mCryptoData = new HashMap<>(count);
            for (int i = 0; i < count; i++) {
                byte[] key = source.createByteArray();
                byte[] value = source.createByteArray();
                mCryptoData.put(ByteBuffer.wrap(key), value);
            }
        }

    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeLong(mSignatureTime.getTime());
        dest.writeParcelable(mPassphrase, 0);
        dest.writeParcelable(mParcelableProxy, 0);
        dest.writeByte((byte) (mCachePassphrase ? 1 : 0));

        dest.writeInt(mCryptoData.size());
        for (HashMap.Entry<ByteBuffer, byte[]> entry : mCryptoData.entrySet()) {
            dest.writeByteArray(entry.getKey().array());
            dest.writeByteArray(entry.getValue());
        }
    }

    public void addParcelableProxy(ParcelableProxy parcelableProxy) {
        mParcelableProxy = parcelableProxy;
    }

    public void addCryptoData(byte[] hash, byte[] signedHash) {
        mCryptoData.put(ByteBuffer.wrap(hash), signedHash);
    }

    public void addCryptoData(Map<ByteBuffer, byte[]> cachedSessionKeys) {
        mCryptoData.putAll(cachedSessionKeys);
    }

    public ParcelableProxy getParcelableProxy() {
        return mParcelableProxy;
    }

    public Map<ByteBuffer, byte[]> getCryptoData() {
        return mCryptoData;
    }

    public Date getSignatureTime() {
        return mSignatureTime;
    }

    public boolean hasPassphrase() {
        return mPassphrase != null;
    }

    public Passphrase getPassphrase() {
        return mPassphrase;
    }

    public static final Creator<CryptoInputParcel> CREATOR = new Creator<CryptoInputParcel>() {
        public CryptoInputParcel createFromParcel(final Parcel source) {
            return new CryptoInputParcel(source);
        }

        public CryptoInputParcel[] newArray(final int size) {
            return new CryptoInputParcel[size];
        }
    };

    @Override
    public String toString() {
        StringBuilder b = new StringBuilder();
        b.append("CryptoInput: { ");
        b.append(mSignatureTime).append(" ");
        if (mPassphrase != null) {
            b.append("passphrase");
        }
        if (mCryptoData != null) {
            b.append(mCryptoData.size());
            b.append(" hashes ");
        }
        b.append("}");
        return b.toString();
    }

}