saml/saml2/binding/SAML2Redirect.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/binding/SAML2Redirect.h
  23  *
  24  * SAML 2.0 HTTP Redirect compression functionality
  25  */
  26
  27 #include <saml/base.h>
  28 #include <iostream>
  29
  30 namespace opensaml {
  31     namespace saml2p {
  32         /**
  33          * Deflates data in accordance with RFC1951. The caller must free the
  34          * resulting buffer using delete[]
  35          *
  36          * @param in        the data to compress
  37          * @param in_len    length of input data
  38          * @param out_len   will contain the length of the resulting data
  39          * @return  allocated buffer of out_len bytes containing deflated data
  40          */
  41         SAML_EXPORT char* deflate(char* in, unsigned int in_len, unsigned int* out_len);
  42
  43         /**
  44          * Inflates data compressed in accordance with RFC1951 and sends the
  45          * results to an output stream.
  46          *
  47          * @param in        the data to inflate
  48          * @param in_len    length of input data
  49          * @param out       reference to output stream to receive data
  50          * @return  number of bytes written to stream
  51          */
  52         SAML_EXPORT unsigned int inflate(char* in, unsigned int in_len, std::ostream& out);
  53     };
  54 };