include/oxs_iv.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef OXS_IV_H
#define OXS_IV_H


/**
  * @file oxs_iv.h
  * @brief Initial Vector related functionalities 
  */

/**
* @defgroup oxs_iv Initial Vector
* @ingroup oxs
* @{
*/
#include <axis2_defines.h>
#include <oxs_constants.h>
#include <openssl_constants.h>
#include <axutil_env.h>

#ifdef __cplusplus
extern "C"
{
#endif


#define OXS_IV_DEFAULT    OPENSSL_DEFAULT_IV16

    /**
     * Generates an Initial Vector(IV) for the given algorithm
     * @param env pointer to environment struct
     * @param key_algo the algorithm
     * @return the generated IV 
     */
    AXIS2_EXTERN axis2_char_t* AXIS2_CALL
    oxs_iv_generate_for_algo(const axutil_env_t *env,
                             axis2_char_t *key_algo);



    /** @} */
#ifdef __cplusplus
}
#endif

#endif                          /* OXS_IV_H */