paa.h

Go to the documentation of this file.

/*****************************************************
 * Copyright (C) 2015 Ping Identity Corporation
 * All rights reserved.
 *
 * The contents of this file are the property of Ping Identity Corporation.
 * You may not copy or use this file, in either source code or executable
 * form, except in compliance with terms set by Ping Identity Corporation.
 * For further information please contact:
 *
 * Ping Identity Corporation
 * 1001 17th St Suite 100
 * Denver, CO 80202
 * 303.468.2900
 * http://www.pingidentity.com
 *
 ****************************************************/

#ifndef _PAA_SDK_PAA_H_
#define _PAA_SDK_PAA_H_ 1

#include <stdlib.h>

#include "apr.h"
#include "apr_pools.h"

#include "paa-http-server-facade.h"
#include "paa-http-client.h"
#include "paa-config.h"
#include "paa-cache.h"
#include "paa-log.h"
#include "paa-util.h"

#define APR_PAA_REQ_ALLOWED (APR_PAA_MODULE_START + 0)

#define APR_PAA_REQ_DENIED (APR_PAA_MODULE_START + 1)

#define APR_PAA_REQ_AGAIN (APR_PAA_MODULE_START + 2)

#define APR_PAA_CACHE_HIT (APR_PAA_MODULE_START + 3)

#define APR_PAA_CACHE_MISS (APR_PAA_MODULE_START + 4)

#ifdef __cplusplus
extern "C" {
#endif

const char *paa_get_version();

const char *paa_get_paap_version();

apr_status_t paa_cache_lookup(apr_pool_t *request_pool,
                              const paa_cache *cache,
                              const paa_client_request *client_req,
                              const paa_agent_response **agent_resp);

void paa_agent_resp_get_status(const paa_agent_response *agent_resp,
                               int *status,
                               const char **reason);

typedef struct paa_header_iter_struct paa_header_iter;

typedef struct paa_header_item_struct {
    const char *name;

    const char *value;
} paa_header_item;

apr_status_t paa_agent_resp_headers_begin(const paa_agent_response *agent_resp,
                                          apr_pool_t *request_pool,
                                          paa_header_iter **iter);

apr_status_t paa_headers_next(paa_header_iter *iter,
                              paa_header_item *output);

typedef struct paa_msg_body_iter_struct paa_msg_body_iter;

typedef struct paa_msg_body_item_struct {
    const unsigned char *data;

    size_t size;
} paa_msg_body_item;

apr_status_t paa_agent_resp_body_begin(const paa_agent_response *agent_resp,
                                       apr_pool_t *request_pool,
                                       paa_msg_body_iter **iter);

apr_status_t paa_msg_body_next(paa_msg_body_iter *iter,
                               paa_msg_body_item *output);

apr_status_t paa_configure_agent_request(apr_pool_t *request_pool,
                                         const paa_config *config,
                                         const paa_client_request *client_req,
                                         const paa_agent_response *agent_resp,
                                         const paa_http_request *request);

apr_status_t paa_process_agent_response(apr_pool_t *request_pool,
                                        const paa_http_response *raw_response,
                                        const paa_cache *cache,
                                        const paa_client_request *client_req,
                                        const paa_agent_response *last_resp,
                                        const paa_agent_response **agent_resp);

int paa_agent_response_req_allowed(const paa_agent_response *resp);

int paa_agent_response_modifies_request(const paa_agent_response *resp);

apr_status_t paa_client_request_modify(apr_pool_t *request_pool,
                                       const paa_client_request *req,
                                       const paa_agent_response *resp);

int paa_agent_response_modifies_response(const paa_agent_response *resp);

apr_status_t paa_client_response_modify(apr_pool_t *request_pool,
                                        const paa_client_response *client_resp,
                                        const paa_agent_response *agent_resp);

apr_status_t paa_submit_agent_request(apr_pool_t *request_pool,
                                      const paa_http_client *http_client,
                                      const paa_config *config,
                                      const paa_cache *cache,
                                      const paa_client_request *client_req,
                                      const paa_client_response *client_resp,
                                      const paa_agent_response **agent_resp);

#ifdef __cplusplus
} /* C */
#endif

#endif /* _PAA_SDK_PAA_H_ */