Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATSecurityContext.h Go to the documentation of this file. /** @file GATSecurityContext.h * Header file for the GATSecurityContext class. * * A container for security information. Each context has a type associated with it. * The type indicates if the GATSecurityContext instance corresponds to a "password" * GATSecurityContext or a "certificate" GATSecurityContext. * * Currently we provide additional auxiliary operations to create a context * based upon password information or upon credentials stored in a file. * GATContexts based upon these mechanisms can be used by adaptors to create * further contexts containing opaque data objects, e.g. GSSAPI credentials. * * @date $Date: 2004/04/01 17:21:28 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSecurityContext.h,v 1.8 2004/04/01 17:21:28 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This file is part of the GAT Engine. * Contributed by Kelly Davis <kdavis@aei.mpg.de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ #ifndef _GATSECURITYCONTEXT_H_ #define _GATSECURITYCONTEXT_H_ 1 #include "GATType.h" #include "GATList.h" #include "GATInternal.h" #ifdef __cplusplus extern "C" { #endif /* GATList_GATSecurityContext */ GATLIST_DECLARE_QUALIFIED(extern, GATSecurityContext, GATList_GATSecurityContext); /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATSecurityContext); /** * Creates a new security context of a specific type. The type indicates * the means by which this instance allows "secure" communications to be * established. The allowed values for this type are the various public * class variables of this class established for this purpose. * * @param type The type of this security context */ GATSecurityContext GATSecurityContext_Create(GATSecurityContextType type); /** * Destroys a security context. * * @param this The GATSecurityContext to destory */ void GATSecurityContext_Destroy(GATSecurityContext *ctx); /** * This fucntion returns the type, a #GATType of the passed #GATSecurityContext_const. * This function will always return #GATType_GATSecurityContext. * * @param this The #GATSecurityContext_const to query * @return The #GATType of the passed @c this */ GATType GATSecurityContext_GetType(GATSecurityContext_const ctx); /** GATSecurityContext_Clone * Clone is used to clone a specified context, copying all * state and security information. The new GATSecurityContext is * completely independent from the original one, which may * be destroyed with no effect on the new one. * * @param this The GATSecurityContext to clone * @param thisClone The cloned GATSecurityContext * @return An error code */ GATResult GATSecurityContext_Clone(GATSecurityContext_const ctx, GATSecurityContext *thisClone); /** * For two GATSecurityContexts to be considered equal requires that they * must be acquired over the same mechanisms and must refer to the same * name. * * @param this The first GATSecurityContext * @param that The second GATSecurityContext * @param isequal Result of comparrison * @return An error code */ GATResult GATSecurityContext_Equals(GATSecurityContext_const ctx, GATSecurityContext_const that, GATBool *isequal); /** GATSecurityContext_GetInterface * This function gets an interface supported by this GATSecurityContext * * The function GATSecurityContext_GetInterface allows to get a pointer to an * additional interface supported by this GATSecurityContext. * * @param object The object to be asked for the new interface. * @param iftype The interface the object is to be asked for. * @param ifp The pointer, through which the result is to be returned. * @return An error type. */ GATResult GATSecurityContext_GetInterface(GATSecurityContext_const object, GATInterface iftype, void const **ifp); /** * Makes this a "Password" type security context and stores the username * and password in the context. * * @param this The GATSecurityContext to modify * @param username Username associated with password * @param password Password * @return A GATResult indicating the GATError return code */ GATResult GATSecurityContext_SetPasswordAuthenticate(GATSecurityContext ctx, const char *username, const char *password); /** * If this is a "Password" type security context get the username and password * from the context. * * @param this The GATSecurityContext to query * @param username Pointer to the username pointer * @param password Pointer to the password pointer * @return A GATResult indicating the error state */ GATResult GATSecurityContext_GetPasswordAuthenticate(GATSecurityContext ctx, char **username, char **password); /** * Makes this a "Certificate" type security context and stores the * information about the location of keyfile and certificate file * in the context. * * @param this The GATSecurityContext to modify * @param keyfile Keyfile, containing valid absolute or relative local * path to keyfile. A relative path will be converted to an absolute * path based upon the current working directory. * @param certificate Certificate, containing valid absolute or local * path to certificate file. A relative path will be converted to an * absolute path based upon the current working directory. * @param passphrase Passphrase (OPTIONAL) * @return A GATResult indicating the GATError return code */ GATResult GATSecurityContext_SetCertificateAuthenticate(GATSecurityContext ctx, const char *keyfile, const char *certificate, const char *passphrase); /** * If this is a "Certificate" type security context get the * information about the location of keyfile and certificate * file stored in the context. * * @param this The GATSecurityContext to query * @param keyfile Pointer to the keyfile pointer * @param certificate Pointer to the certificate pointer * @param passphrase Pointer to the passphrase pointer * @retun A GATResult indicating success */ GATResult GATSecurityContext_GetCertificateAuthenticate(GATSecurityContext ctx, char **keyfile, char **certificate, char **passphrase); /** * Makes this a "Remote" type security context and stores the information * about the location of remote credential server in the context. * * @param this The GATSecurityContext to modify * @param location Location for remote credential server * @param name Username associated with the credential * @param passphrase Passphrase associated with the credential * @return A GATResult indicating the GATError return code */ GATResult GATSecurityContext_SetRemoteAuthenticate(GATSecurityContext ctx, GATLocation location, const char *name, const char *passphrase); /** * If this is a "Remote" type security context get the information about * the location of remote credential server stored in the context. * * @param this The GATSecurityContext to query * @param location Pointer to the GATLocation * @param name Pointer to the name pointer * @param passphrase Pointer to the passphrase pointer * @retun A GATResult indicating success */ GATResult GATSecurityContext_GetRemoteAuthenticate(GATSecurityContext ctx, GATLocation *location, char **name, char **passphrase); /** * This function returns the GATSecurityContextType of this GATSecurityContext * * @param this The GATSecurityContext to query * @param type The GATSecurityContextType of this * @return An error code */ GATResult GATSecurityContext_GetSecurityContextType(GATSecurityContext ctx, GATSecurityContextType *type); #ifdef __cplusplus } #endif #endif /* _GATSECURITYCONTEXT_H_ */