mobile/android/base/sync/middleware/Crypto5MiddlewareRepositorySession.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/base/sync/middleware/Crypto5MiddlewareRepositorySession.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,175 @@
     1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.7 +
     1.8 +package org.mozilla.gecko.sync.middleware;
     1.9 +
    1.10 +import java.io.UnsupportedEncodingException;
    1.11 +import java.util.concurrent.ExecutorService;
    1.12 +
    1.13 +import org.mozilla.gecko.sync.CryptoRecord;
    1.14 +import org.mozilla.gecko.sync.crypto.CryptoException;
    1.15 +import org.mozilla.gecko.sync.crypto.KeyBundle;
    1.16 +import org.mozilla.gecko.sync.repositories.InactiveSessionException;
    1.17 +import org.mozilla.gecko.sync.repositories.NoStoreDelegateException;
    1.18 +import org.mozilla.gecko.sync.repositories.RecordFactory;
    1.19 +import org.mozilla.gecko.sync.repositories.RepositorySession;
    1.20 +import org.mozilla.gecko.sync.repositories.delegates.RepositorySessionFetchRecordsDelegate;
    1.21 +import org.mozilla.gecko.sync.repositories.delegates.RepositorySessionStoreDelegate;
    1.22 +import org.mozilla.gecko.sync.repositories.domain.Record;
    1.23 +
    1.24 +/**
    1.25 + * It's a RepositorySession that accepts Records as input, producing CryptoRecords
    1.26 + * for submission to a remote service.
    1.27 + * Takes a RecordFactory as a parameter. This is in charge of taking decrypted CryptoRecords
    1.28 + * as input and producing some expected kind of Record as output for local use.
    1.29 + *
    1.30 + *
    1.31 +
    1.32 +
    1.33 +
    1.34 +                 +------------------------------------+
    1.35 +                 |    Server11RepositorySession       |
    1.36 +                 +-------------------------+----------+
    1.37 +                           ^               |
    1.38 +                           |               |
    1.39 +                        Encrypted CryptoRecords
    1.40 +                           |               |
    1.41 +                           |               v
    1.42 +                 +---------+--------------------------+
    1.43 +                 | Crypto5MiddlewareRepositorySession |
    1.44 +                 +------------------------------------+
    1.45 +                           ^               |
    1.46 +                           |               |  Decrypted CryptoRecords
    1.47 +                           |               |
    1.48 +                           |            +---------------+
    1.49 +                           |            | RecordFactory |
    1.50 +                           |            +--+------------+
    1.51 +                           |               |
    1.52 +                          Local Record instances
    1.53 +                           |               |
    1.54 +                           |               v
    1.55 +                 +---------+--------------------------+
    1.56 +                 |  Local RepositorySession instance  |
    1.57 +                 +------------------------------------+
    1.58 +
    1.59 +
    1.60 + * @author rnewman
    1.61 + *
    1.62 + */
    1.63 +public class Crypto5MiddlewareRepositorySession extends MiddlewareRepositorySession {
    1.64 +  private KeyBundle keyBundle;
    1.65 +  private RecordFactory recordFactory;
    1.66 +
    1.67 +  public Crypto5MiddlewareRepositorySession(RepositorySession session, Crypto5MiddlewareRepository repository, RecordFactory recordFactory) {
    1.68 +    super(session, repository);
    1.69 +    this.keyBundle = repository.keyBundle;
    1.70 +    this.recordFactory = recordFactory;
    1.71 +  }
    1.72 +
    1.73 +  public class DecryptingTransformingFetchDelegate implements RepositorySessionFetchRecordsDelegate {
    1.74 +    private RepositorySessionFetchRecordsDelegate next;
    1.75 +    private KeyBundle keyBundle;
    1.76 +    private RecordFactory recordFactory;
    1.77 +
    1.78 +    DecryptingTransformingFetchDelegate(RepositorySessionFetchRecordsDelegate next, KeyBundle bundle, RecordFactory recordFactory) {
    1.79 +      this.next = next;
    1.80 +      this.keyBundle = bundle;
    1.81 +      this.recordFactory = recordFactory;
    1.82 +    }
    1.83 +
    1.84 +    @Override
    1.85 +    public void onFetchFailed(Exception ex, Record record) {
    1.86 +      next.onFetchFailed(ex, record);
    1.87 +    }
    1.88 +
    1.89 +    @Override
    1.90 +    public void onFetchedRecord(Record record) {
    1.91 +      CryptoRecord r;
    1.92 +      try {
    1.93 +        r = (CryptoRecord) record;
    1.94 +      } catch (ClassCastException e) {
    1.95 +        next.onFetchFailed(e, record);
    1.96 +        return;
    1.97 +      }
    1.98 +      r.keyBundle = keyBundle;
    1.99 +      try {
   1.100 +        r.decrypt();
   1.101 +      } catch (Exception e) {
   1.102 +        next.onFetchFailed(e, r);
   1.103 +        return;
   1.104 +      }
   1.105 +      Record transformed;
   1.106 +      try {
   1.107 +        transformed = this.recordFactory.createRecord(r);
   1.108 +      } catch (Exception e) {
   1.109 +        next.onFetchFailed(e, r);
   1.110 +        return;
   1.111 +      }
   1.112 +      next.onFetchedRecord(transformed);
   1.113 +    }
   1.114 +
   1.115 +    @Override
   1.116 +    public void onFetchCompleted(final long fetchEnd) {
   1.117 +      next.onFetchCompleted(fetchEnd);
   1.118 +    }
   1.119 +
   1.120 +    @Override
   1.121 +    public RepositorySessionFetchRecordsDelegate deferredFetchDelegate(ExecutorService executor) {
   1.122 +      // Synchronously perform *our* work, passing through appropriately.
   1.123 +      RepositorySessionFetchRecordsDelegate deferredNext = next.deferredFetchDelegate(executor);
   1.124 +      return new DecryptingTransformingFetchDelegate(deferredNext, keyBundle, recordFactory);
   1.125 +    }
   1.126 +  }
   1.127 +
   1.128 +  private DecryptingTransformingFetchDelegate makeUnwrappingDelegate(RepositorySessionFetchRecordsDelegate inner) {
   1.129 +    if (inner == null) {
   1.130 +      throw new IllegalArgumentException("Inner delegate cannot be null!");
   1.131 +    }
   1.132 +    return new DecryptingTransformingFetchDelegate(inner, this.keyBundle, this.recordFactory);
   1.133 +  }
   1.134 +
   1.135 +  @Override
   1.136 +  public void fetchSince(long timestamp,
   1.137 +                         RepositorySessionFetchRecordsDelegate delegate) {
   1.138 +    inner.fetchSince(timestamp, makeUnwrappingDelegate(delegate));
   1.139 +  }
   1.140 +
   1.141 +  @Override
   1.142 +  public void fetch(String[] guids,
   1.143 +                    RepositorySessionFetchRecordsDelegate delegate) throws InactiveSessionException {
   1.144 +    inner.fetch(guids, makeUnwrappingDelegate(delegate));
   1.145 +  }
   1.146 +
   1.147 +  @Override
   1.148 +  public void fetchAll(RepositorySessionFetchRecordsDelegate delegate) {
   1.149 +    inner.fetchAll(makeUnwrappingDelegate(delegate));
   1.150 +  }
   1.151 +
   1.152 +  @Override
   1.153 +  public void setStoreDelegate(RepositorySessionStoreDelegate delegate) {
   1.154 +    // TODO: it remains to be seen how this will work.
   1.155 +    inner.setStoreDelegate(delegate);
   1.156 +    this.delegate = delegate;             // So we can handle errors without involving inner.
   1.157 +  }
   1.158 +
   1.159 +  @Override
   1.160 +  public void store(Record record) throws NoStoreDelegateException {
   1.161 +    if (delegate == null) {
   1.162 +      throw new NoStoreDelegateException();
   1.163 +    }
   1.164 +    CryptoRecord rec = record.getEnvelope();
   1.165 +    rec.keyBundle = this.keyBundle;
   1.166 +    try {
   1.167 +      rec.encrypt();
   1.168 +    } catch (UnsupportedEncodingException e) {
   1.169 +      delegate.onRecordStoreFailed(e, record.guid);
   1.170 +      return;
   1.171 +    } catch (CryptoException e) {
   1.172 +      delegate.onRecordStoreFailed(e, record.guid);
   1.173 +      return;
   1.174 +    }
   1.175 +    // Allow the inner session to do delegate handling.
   1.176 +    inner.store(rec);
   1.177 +  }
   1.178 +}

mercurial