include/rampart_authn_provider.h (64 lines of code) (raw):

/* * 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 RAMPART_AUTHN_PROVIDER_H #define RAMPART_AUTHN_PROVIDER_H /** * @file rampart_authn_provider.h * @brief The authentication interface of rampart. Validates a username and password pair. */ /** * @defgroup rampart_authn_provider Authentication Provider * @{ */ #include <axutil_param.h> #include <axis2_defines.h> #include <axutil_error.h> #include <axutil_env.h> #include <axutil_utils.h> #include <axis2_msg_ctx.h> #ifdef __cplusplus extern "C" { #endif enum rampart_authn_provider_status { RAMPART_AUTHN_PROVIDER_DENIED = 0, RAMPART_AUTHN_PROVIDER_GRANTED, RAMPART_AUTHN_PROVIDER_FOUND, RAMPART_AUTHN_PROVIDER_USER_FOUND, RAMPART_AUTHN_PROVIDER_USER_NOT_FOUND, RAMPART_AUTHN_PROVIDER_GENERAL_ERROR }; typedef enum rampart_authn_provider_status rampart_authn_provider_status_t; /** * Struct to authenticate username/password pair * @{ */ typedef struct rampart_authn_provider_ops rampart_authn_provider_ops_t; typedef struct rampart_authn_provider rampart_authn_provider_t; struct rampart_authn_provider_ops { /** * Check plain text passwords. If the UseranmeToken is in plain text * this function will be called. * @param authn_provider the authentication provider struct * @param env pointer to environment struct * @param msg_ctx message context * @param username the username * @param password the password in plain text * @return the status of the check */ rampart_authn_provider_status_t (AXIS2_CALL* rampart_authn_provider_check_password)( rampart_authn_provider_t *authn_provider, const axutil_env_t* env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *password); /** * Check digested passwords. If the UseranmeToken is in password digest form * this function will be called. * @param authn_provider the authentication provider struct * @param env pointer to environment struct * @param msg_ctx message context * @param username the username * @param nonce the nonce or the random value of the username token * @param created the created value of the username token * @param digest the digest value of the SHA-1(password+created+nonce) * @return the status of the check */ rampart_authn_provider_status_t (AXIS2_CALL* rampart_authn_provider_check_password_digest)( rampart_authn_provider_t *authn_provider, const axutil_env_t* env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *nonce, const axis2_char_t *created, const char *digest); /** * The free function to free all resources allocated * @param authn_provider the authentication provider struct * @param env pointer to environment struct * @return AXIS2_SUCCESS on success. AXIS2_FAILURE otherwise. */ axis2_status_t (AXIS2_CALL* free)( rampart_authn_provider_t *authn_provider, const axutil_env_t* env); }; struct rampart_authn_provider { rampart_authn_provider_ops_t *ops; axutil_param_t *param; }; /*************************** Function macros **********************************/ #define RAMPART_AUTHN_PROVIDER_FREE(authn_provider, env) \ ((authn_provider)->ops->free (authn_provider, env)) #define RAMPART_AUTHN_PROVIDER_CHECK_PASSWORD(authn_provider, env, msg_ctx, username, password) \ ((authn_provider)->ops->rampart_authn_provider_check_password( \ authn_provider, env, msg_ctx, username, password)) #define RAMPART_AUTHN_PROVIDER_CHECK_PASSWORD_DIGEST(authn_provider, env, msg_ctx, username, nonce, nonce_length, digest) \ ((authn_provider)->ops->rampart_authn_provider_check_password_digest( \ authn_provider, env, msg_ctx, username, nonce, nonce_length, digest)) /** @} */ #ifdef __cplusplus } #endif #endif /* RAMPART_AUTHN_PROVIDER_H */