mods/_standard/social/lib/BlobCrypter.php

   1 <?php
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21 class BlobCrypterException extends Exception {
  22 }
  23
  24 /**
  25  * Utility interface for managing signed, encrypted, and time stamped blobs.
  26  * Blobs are made up of name/value pairs.  Time stamps are automatically
  27  * included and checked.
  28  *
  29  */
  30 abstract class BlobCrypter {
  31
  32   /**
  33    * Time stamps, encrypts, and signs a blob.
  34    *
  35    * @param in name/value pairs to encrypt
  36    * @return a base64 encoded blob
  37    *
  38    * @throws BlobCrypterException
  39    */
  40   abstract public function wrap(Array $in);
  41
  42   /**
  43    * Unwraps a blob.
  44    *
  45    * @param in blob
  46    * @param maxAgeSec maximum age for the blob
  47    * @return the name/value pairs, including the origin timestamp.
  48    *
  49    * @throws BlobExpiredException if the blob is too old to be accepted.
  50    * @throws BlobCrypterException if the blob can't be decoded.
  51    */
  52   abstract public function unwrap($in, $maxAgeSec);
  53 }