Table of contents

General

• CInf
  • C Class that provides a C compatible interface to communicate with Akenti Server
  • C Provides a C compatible interface to call the akenti policy engine
  • C Used by the globus authorization callout
  • C
• certs
  • elements
• dirServices
• parsers
• policyEngine
  • access
  • cache
  • check
• serverClient
  • elements
  • http
  • soap
• shared
  • base
  • net
  • openssl
  • security
• util

Classes

• AbstractIOHandlerImpl This is an abstract class IOHandler that defines the methods for a descriptor such as determining if the input/output descriptor is open or closed and read and write methods for the descriptor
• AKCertHolderImpl The AKCertHolder holds an AkentiCertficate, the level of the trust verification, and caching start/end times
• AkentiCertGenerator This class provides functionality will be used by all the akenti generators
• AkentiCertificate AkentiCertificate is a simple reference-count wrapper aroubd AkentiCertificateImpl
• AkentiCertificateFactory AkentiCertificateFactory
• AkentiCertificateImpl This abstract class is the base for all the akenti certificates implementations
• AkentiEngine Class that provides the methods to check a user's access to resource
• AkentiInit This class provides static methods to configure the akenti system
• AkentiInputStream An AkentiInputStream is used to deserialize objects from an ASCI string that was written using the conventions defined in AkentiOutputStream
• AkentiIssuer An AkentiIssuer holds an AkentiPrincipal and the directories where its chain of x509 certs is stored
• AkentiMessage

  100-199 Ok messages
  
  200-249 Problems that the client finds : cannot connect to server
  
  250-299 Problems that server finds: wrong request, bad credential
  - user needs to fix something
  300-399 Permission denied - errors from the Authorizer   
  - maps to user as permission denied, 
  400-499 Problems in policy collection and verififcation  
  500-599 Problems in UseCondition collection and verification
  - both map to user as policy is inconsistant
  900-999 Programming errors exceptions and errors caught
  - maps to user as code is wrong
  

• AkentiObject Defines the interface that Akenti elements must implement
• AkentiOutputStream An AkentiOutputStream object is used to serialize all types of objects using a simple scheme to write the objects' string reprsentations
• AkentiPrincipal An AkentiPrincipal is used to represent an entity in the Akenti world
• AkentiRequest Base class for AkentiRequests
• AkentiRequests Holds an ordered list of AkentiRequest
• AkentiResponse Base class to handle Akenti responses
• AkentiResponses Holds an ordered list of AkentiResponses
• AkentiX509Certificate
• AkentiX509CertificateImpl This is is used internally by the engine
• AKRuntime
• AttributeCertGenerator Used to generate an Attribute certificate
• AttributeCertificate
• AttributeCertificateImpl This class provides the implementation of an attribute certificate
• AttributeInfo An AttributeInfo consists mainly of an attribute, a value, and possibly a list of cas/issuers/authorities depending on its type
• Base64 A Base64 object is a reference-count pointer that wraps a Base64Impl object
• Base64Impl This abstract class provides part of the functionality of the Base 64 encoding/decoding
• CacheCertGenerator
• CacheCertificate
• CacheCertificateImpl The CacheCertificate holds one or more AkentiCertificates to be cached
• CacheRequest CacheRequest
• CacheResponse CacheResponse
• CapabilityCertGenerator CapabilityCertGenerator
• CapabilityCertificate
• CapabilityCertificateImpl This class provides the implementation of a capability certificate
• Certificate A Certificate object is a reference-count pointer that wraps a CertificateImpl object
• CertificateAuthorityInfo A CertificateAuthorityInfo holds ca's chain of x509 certs
• CertificateCache The CertificateCache caches certificates in memory
• CertificateChain A CertificateChain object is a reference-count pointer that wraps a CertificateChainImpl object
• CertificateChainImpl This abstract class defines an interface to a generic chain of certificates
• CertificateException CertificateException
• CertificateFactory A CertificateFactory is a reference-count pointer that wraps a CertificateFactoryImpl
• CertificateFactoryImpl This abstract class provides applications with an interface for X509 certificate generation, encoding and decoding
• CertificateGenerator A CertificateGenerator object is a reference-count pointer that wraps a CertificateGeneratorImpl object
• CertificateGeneratorImpl This abstract class provides applications with certificate generation
• CertificateImpl This abstract class defines an interface to a generic signed certificate
• CertificateInfo CertificateInfo holds (possibly) a certificate and info about it
• CertificateRequest A CertificateRequest object is a reference-count pointer that wraps a CertificateRequestImpl
• CertificateRequestGenerator A CertificateRequestGenerator object is a reference-count pointer that wraps a CertificateRequestGeneratorImpl object
• CertificateRequestGeneratorImpl This abstract class groups all services of setting up a CertificateRequestGenerator which includes setting subject publicKey, versionNumber, generating CertificateRequest with specified algorithm and privateKey, displaying the Certificate in string
• CertificateRequestImpl This abstract class provides the methods for getting the information about a CertificateRequest such as subject, publicKey, versionNumber, signatureAlgorithm or signature
• CertificateRetrievalFactory Class to manage CertificatRetrieval instances
• CertificateRetrievalImpl Class used to retrieve certificate and Akenti certificate
• CertificateRevocationList A CertificateRevocationList object is a reference-count pointer that wraps a CertificateRevocationListImpl object
• CertificateRevocationListImpl This abstract class provides the methods of getting the information associated with CertificateRevocationList such as version, guarantor, signature,lastUpdate time, nextUpdate time, and also the list of the Certificates which have been revoked
• CertificateStatusListener CertificateStatusListener
• CertificateVerifier A CertificateVerifier is used to verify AkentiCertificate certificates
• CertInfo Class CertInfo contains all the information pertaining to one Policy or Use Condition certificate and whether it was used or not in determining whether to provide access to a user
• CertInfoCollector The CertInfoCollector contains all the certificates collected in the process of trying to determine if a request can be satisfied
• CheckAccessRequest Holds the content of a CheckAccessRequest
• CheckAccessResponse Used to wrap the response to a CheckAccessRequest
• CheckPolCertCollector A CheckPolCertCollector collects and verifies Policy certificates
• CheckPolicyRequest Holds the content of a CheckPolicyRequest
• CheckPolicyResponse Class to handle the contents of the response message to to a check policy request
• CheckUCCertCollector A CheckUCCertCollector collects UseCondition certificates and verifies them
• Cipher DES-EDE, DES-ECB, DES-CBC
• CipherImpl
• Condition Holds a boolean expression and a vector of AttributeInfo objects that describe the attribute/value pairs contained in the expression
• ConditionalActions Holds a boolean expression and a vector of AttributeInfo objects that describe the attribute/value pairs contained in the expression and a list of actions that will be granted if the expression evaluates to true
• CreateResourceRequest Class to handle the arguments in a CreateResourceRequest
• CreateResourceResponse Class to handle CreateResourceResponse
• DeletePolicyCertificateRequest Used to handle DeletePolicyCertificateRequest
• DeletePolicyCertificateResponse Used to wrap the response to a DeletePolicyCertificateRequest
• Directory A Directory object contains a string representation of a URL
• DirectoryServiceException DirectoryServiceException
• DistinguishedName This is a class to hold a Distinguished Name as a set of name and value pairs
• DummyCertificate The DummyCertificate is used in CertInfo objects that must exist to hold catastrophic error messages that occur before any certificates are collected (e
• DummyCertificateImpl The dummy certificate is used in CertInfo objects that must exist to hold catastrophic error messages that occur before any certificates are collected (e
• Error Errors thrown by the Akenti libraries when it encounters some error that can only be caused by incorrect code in the library
• Exception This is the base class of all Exceptions thrown by the Akenti libraries
• Expression This class is used to parse a string boolean expression into an internal tree represenation and to evaluate or reduce the expression for a given user
• ExpressionEvaluator ExpressionEvaluator
• ExpressionParser
• ExpressionScanner ExpressionScanner
• ExpressionVisitor ExpressionVisitor
• ExternalCache
• ExternalCacheImpl ExternalCacheImpl
• ExternalEvaluator Safe wrapper around the ExternalEvaluatorImpl
• ExternalEvaluatorImpl Subclass implementors should overide the virtual public methods to help the engine evaluate
• FileCertificateRetrievalImpl Class to retrieve certificate from file
• FileExternalCacheImpl FileExternalCacheImpl
• FileURLHandlerImpl A FileURLHandlerImpl is an object that implements the services for a file URL that are provided by the base class, URLHandlerImpl
• Filter A Filter is the base class for filter functions
• GetResourceInfoRequest
• GetResourceInfoResponse Class to handle the contents of the response message to to a get resource info request
• Hmac
• HmacImpl
• HttpBase A convenience class that implements behavior common to HttpRequest and HttpResponse
• HttpCertificateRetrievalImpl Class to retrieve certificate from a HTTP server
• HttpConstants HTTP constants
• HttpRequest
• HttpResponse
• HttpURLHandlerImpl A HttpURLHandlerImpl object provides the services for an http URL that are not provided by the base class, URLHandlerImpl
• InputStream A InputStream object is a reference-count pointer that wraps a istream
• IOException This is the base class of all Input/Output exceptions
• IOHandlerImpl This class wraps a file descriptor and provides methods to get information about the descriptor and to read and write from the descriptor
• KeyFactory A KeyFactory is a reference-count pointer that wraps a KeyFactoryImpl
• KeyFactoryImpl This abstract class provides applications with key generation, PEM or DER encoding and decoding for key export and import
• KeyPair This class is a simple holder for a key pair, a public key and a private key
• KeyStore A KeyStore is a reference-count pointer that wraps a KeyStoreImpl
• KeyStoreImpl
• LdapCertificateRetrievalImpl Class to retrieve certificate from a LDAP server
• LdapURLHandlerImpl A LdapURLHandlerImpl object provides the services for an http URL that are not provided by the base class, URLHandlerImpl
• Logger Logger
• LogInterface LogInterface
• MalformedURLException This exception is used to report Malformed URLs
• MessageDigest A MessageDigest object is a reference-count pointer that wraps a MessageDigestImpl object
• MessageDigestImpl This abstract class provides applications with the interface of a message digest algorithm, such as MD5 or SHA1
• OpaqueCertificate Class that handles writing/reading a PEM encoded certificate in a CollectPolicyResponse
• OpenSSLBase64Impl This class is the subclass of Base64Impl which implements the functionality of Base64 data encoding and decoding
• OpenSSLCertificateFactoryImpl A subclass of CertficateFactoryImpl that is used to create OpenSSLCertificates or OpenSSLCertificateReqests from encoded representations of these objects, to create Generators for OpenSSLCertificates or OpenSSLCertificateRequests, and to encode OpenSSLCertficates or OpenSSLCertificateRequests for exporting
• OpenSSLCertificateGeneratorImpl This class is the subclass of CertificateGeneratorImpl,it implements the methods used to initialize and generate a Certificate which contains an OpenSSLX509CertficateImpl
• OpenSSLCertificateRequestGeneratorImpl This class is a subclass of CertificateRequestGeneratorImpl, and is used to create an OpenSSLCertificateRequestImpl and the CertfificateRequest that points to it
• OpenSSLCertificateRequestImpl This class is a subclass of CertificateRequestImpl and is a wrapper for the openssl X509_REQ structure
• OpenSSLCipherImpl
• OpenSSLContextImpl A wrapper around SSL_CTX whic is used to store the credentials of a server/client and the trusted ca certs
• OpenSSLCRLImpl An OpenSSLCRLImpl object is a subclass of CertificateRevocationListImpl
• OpenSSLHmacImpl
• OpenSSLKeyFactoryImpl This class is a subclass of KeyFactoryImpl which has methods for key generation, encoding, and decoding
• OpenSSLKeyImpl This class wraps an ssl ENV_PKEY structure which it assumes contains a private and public RSA key pair
• OpenSSLMessageDigestImpl This class is instantiated from superclass MessageDigestImpl and uses hash algorithms such as MD5 or SHA1 to produce a fixed length output from an arbitrary-length input message
• OpenSSLPrivateKeyImpl This class is instantiated from two superclasses OpenSSLKeyImpl and PrivateKeyImpl and wraps the privateKey methods of OpenSSLKeyImpl
• OpenSSLProviderImpl This class uses the Open SSL crypto library
• OpenSSLPublicKeyImpl This class is instantiated from two superclasses OpenSSLKeyImpl and PublicKeyImpl and wraps the publicKey methods of OpenSSLKeyImpl
• OpenSSLSignatureImpl This class implements the digital signature interface defined in SignatureImpl by holding a ENV_MD_CTX object and wrapping the appropriate openssl functions
• OpenSSLUtil Provides some functions that can de/endcode strings and functions to populate X509 name with distinguished name or with the principal
• OpenSSLX509CertificateImpl This class is the subclass of CertificateImpl and it provides all the services the opensl X509 certificate supports
• OpenSSLX509RevokedCertificateImpl This class is the subclass of RevokedCertificateImpl it implements Certificate following the X
• OutputStream A OutputStream object is a reference-count pointer that wraps a ostream object
• ParserException This exception is used to point any parser exceptions
• ParsingException Parsing Exception thrown when a parsing error is encountered
• PKCS12KeyStoreImpl
• PolicyAuthorizer A PolicyAuthorizer evalautes the UseCondition certifcates and generates Capability if at least one UseCondition certificate has been satisfied or partially satisfied and if no UseCondition certificate with the enable flag set is not satisfied
• PolicyCertGenerator PolicyCertGenerator
• PolicyCertificate
• PolicyCertificateImpl A Policy certificate specifies the use-condition certificates issuers, directories where to search for attribute and identity certificates
• PolicyChecker A PolicyChecker goes through all the Policy certificates available for the given resource, and all the Use Condition certificates associated with the Policy certificates collected so far
• PolicyCollector A PolicyCollector collects and verifies Policy certificates
• PolicyContextImpl The policy context contains all the relevent information that was used by the engine to satisfy a request
• PolicyImpl Wraps a policy cert and is used to store UseCondition certs that apply to the policy cert's resource
• PolicyInfo Holds a list of CertificateResponses
• PrivateKey A PrivateKey object is a reference-count pointer that wraps a PrivateKeyImpl object
• PrivateKeyImpl This abstract class defines part of the interface for PrivateKey Implementation objects
• Properties The Properties class holds a set of named properties
• Provider A Provider object is a reference-count pointer that wraps a ProviderImpl object
• ProviderImpl A ProviderImpl object provides applications with engines that implement security algorithms
• PublicKey A PublicKey object is a reference-count pointer that wraps a PublicKeyImpl object
• PublicKeyImpl This abstract class mainly serves to group all public key objects
• ref_ptr This class implements a simple reference counting scheme that simplifies memory management
• ResourceBrowseRequest Use this to list resources under a given resource
• ResourceBrowseResponse Contains a list or resources in responsese to to a ResourceBrowseRequest
• RevokedCertificate A RevokedCertificate object is a reference-count pointer that wraps a RevokedCertificateImpl object
• RevokedCertificateImpl This abstract class provides the information about a certificate which has been revoked
• SecretKey This class is used for symmetric keys
• SecureSocketImpl Base abstract class for SecureSocket implementations - inherits from SocketImpl and adds a security context
• SecurityException This is the generic Security exception
• ServerContext Class to hold the Akenti server credentials which are used to sign cache and capability credentials
• ServerExternalCacheImpl ServerExternalCacheImpl
• ServerSocket The ServerSocket provides the services needed for socket for the server
• Signature A Signature object is a reference-count pointer that wraps a SignatureImpl object
• SignatureImpl This abstract class provides applications with the interface of a digital signature algorithm such as RSA-MD5 or DSA-SHA1
• SoapEnvelope Internal class to wrap a DOMElement containing XML content These methods are called by SoapHttpResponseImpl and SoapHttpRequestImpl and hide some of the details of soap messages
• SoapHttpRequest Handles soap requests over http
• SoapHttpResponse Handles a soap response over http
• Socket A Socket contains a reference count that wraps a SocketImpl object
• SocketImpl A SocketImpl object provides the implementation for both server and client socket functions such as set/get the host, set/get the port, do the connect, bind, listen and accept for the socket
• SocketImplFactory This abstract class provides applications with socket generation
• SocketInputStream A SocketInputStream is subclass of istream
• SocketOutBuffer A SocketOutBuffer is a user-defined stream buffer for writing characters into the stream
• SocketOutputStream A SocketOuputStream subclass of ostream
• SSLContext A ref_ptr class to wrap a security context
• SSLContextImpl Interface for security contexts that mainly hold credentials and trusted ca infos
• SSLServerSocket SSLServerSocket class - derived from ServerSocket but has a SSLcontext associated with it
• SSLSocket SSLSocket class - derived from Socket but has a SSLcontext associated with it
• StreamTokenizer This a simple stream tokenizer
• StringTokenizer This a simple string tokenizer
• StringUtil A simple utility class that provides static function that compare strings
• TreeNode Tree
• UploadPolicyCertificateRequest Used to upload a poliy certificate
• UploadPolicyCertificateResponse Used to wrap the response to an UploadPolicyCertificateRequest
• URL URL class refers to Uniform Resource Locator and can be used to locate resources on the Internet
• URLConnection A URLConnection object is a ref_ptr to a URLConnectionImpl that wraps a URLHandlerImpl
• URLConnectionImpl A URLConnectionImpl is an abstract class that holds a URL and its connection state, and input and/or output streams
• URLHandler A URLHandler object is a reference-count pointer that wraps a URLHandlerImpl
• URLHandlerFactory A URLHandlerFactory object is a reference-count pointer that wraps a URLHandlerFactoryImpl
• URLHandlerFactoryImpl Contains a map of URL protocols and their URLHandlers
• URLHandlerImpl A URLHandlerImpl is base class for URL protocol-specific handlers
• UseCondCertGenerator Used to generate a UseCondition certificate
• UseCondCertificate
• UseCondCertificateImpl These certificates are mainly used by the stakeholders or resource owners to place a use condition on the access/usage of a resource
• UseCondCollector A UseCondCollector collects UseCondition certificates and verifies them
• UseCondIssuerGroup A UseCondIssuerGroup object consists of one more AkentiPrincipal who represent Use-Condition Certificate Issuers and one or more locators that are used to locate Use-Condition certificates issued by those issuers
• UtcTime A UtcTime object provides the operations for utctime objects
• V3Extension This class implements the extended functionalities of Version 3 of X509 certificates
• XStr Used to convert chars to XMLchars

Functions, Macros

• (*EvalCallBack) Signature of the callback routine
• akentiClientInit Initializes the client interface according to the values in an akentiClient configuration file
• akentiGlobusCheck Checks a user's access to executables managed by the GLOBUS Job Manager
• akentiInit Initializes the Akenti policy engine
• AKMsg_free Frees an AKMessage
• AKMsg_getCode Returns the status code rom an AKMessage
• AKMsg_getDescription Returns the description of an AKMessage
• AKPrin_getGuarantor Copies the AKPrincipal's CA's distinguished name into buff
• AKPrin_getName Copies the AKPrincipal's distinguished name into buff
• Attr_getAttributeName Returns the name of an attribute
• Attr_getType Returns the type of an Attibute
• Attr_getValue Returns the value of the attribute
• bLog
• CapCert_checkValidity Checks the validity time of the capability certificate
• CapCert_condActionsAt Returns the CondActions at index idx
• CapCert_free Destroys a CapCert
• CapCert_getIssuer Returns the issuer of the capability certificate
• CapCert_getNotAfter Returns the time after which the capability certificate is no longer valid
• CapCert_getNotBefore Returns the time before which the capability certificate is not valid
• CapCert_getResource Returns the name of the resource that the capability certificate applies to
• CapCert_getSubject Returns the subject of the capability certificate
• CapCert_getSubjectPublicKey Returns the subject's public key from the capability certificate
• CapCert_getVersionNumber Returns the version number of the capability certificate
• CapCert_grantedActionAt Returns the action at index idx
• CapCert_hasCondActions Checks if there are CondActions in a CapCert
• CapCert_hasGrantedActions Checks if there are granted unconditional actions in a CapCert
• CapCert_initFromFile Initializes a CapCert from a PEM file
• CapCert_initFromString Initializes a CapCert from a string
• CapCert_numOfCondActions Returns the number of CondActions in a CapabilityCertificate
• CapCert_numOfGrantedActions Returns the number of granted actions in a CapCert
• CapCert_toText Writes pretty text to buffer
• CapCert_writeToBuffer Writes cert to buffer
• CapCert_writeToFile Writes cert to file
• checkAccess Given an authenticated principal name which consists of an x509 distinguished name for a user, and the x509 distinguished name of the Certificate Authority which issued the user's x509 cert, and the name of the resource, returns a capability certificate if any rights are granted
• checkAccessByCertFile Given a file containing a PEM encoded x509 certificate for a user, and the name of the resource, returns a capability certificate if any rights are granted
• checkAccessByCertString Given a string containing a PEM encoded x509 certificate for a user, and the name of the resource, returns a capability certificate if any
• CondAct_actionAt Returns the action at index idx
• CondAct_AttrInfoAt Returns the AttrInfo at index idx
• CondAct_evaluate Traverses the expression in CondActions and calls func with the arguments
• CondAct_getConstraint Returns the constraint string from a CondActions pointer
• CondAct_isCritical Return whether the constraint must be satisfied
• CondAct_numOfActions Returns the number of actions in CondActions
• CondAct_numOfAttrInfos Returns the number of AttrInfos in CondActions
• deleteLogger
• fLog
• flush
• getInstance
• handle
• handle
• iLog
• initLogger
• operator<< Writes the exception message to the stream
• operator<< Writes the Error exception message to the stream
• operator<< Writes the utcTime to the stream
• operator<< Writes the PEM encoding of a certificate to the output stream
• operator>> Initializes the PEM encoding of a certificate to the output stream
• operator>> Reads the utcTime from the stream
• ProtocolHandler
• ProtocolHandler
• remoteCheckAccess Given the DN of a user and the DN of the CA that issued this name and the name of the resource, returns the capability structure which contains the unconditional and conditional rights
• remoteCheckAccessByCertFile Given a file name which contains a PEM encoded x509 certificate or certificate chain for a user, and the name of the resource, returns the capability structure which contains the unconditional and conditional rights
• remoteCheckAccessByCertString Given a string containing a PEM encoded x509 certificate for a user, and the name of the resource, returns the capability structure which contains the unconditional and conditional rights
• sLog
• UTCT_toUtcString Copies the UTCTime's string representation
• ~ProtocolHandler

Variables

• AK_CERT_ENC_TYPE This version defaults to XML
• AKCertHolder Class AKCertHolder serves as the wrapper class for AKCertHolder objects
• CacheDir Caching to file system
• CacheHost Caching to server
• Caching Cache configuration
• CapCert A minimal C interface to a capabilty certificate
• CertificateImpl This class implements the methods specific to OpenSSLsecureSockets and inherits methods from SerureSocketImpl and SocketImpl
• CertificateRetrieval Class CertificateRetrieval serves as the wrapper class for CertificateRetrievalImpl objects
• CURRENT_PROT_NAME_SPACE This version's namespaces
• CURRENT_VERSION Akenti version number
• Filter A File object contains a filename and provides methods to return informataion about the name or directory
• IOHandler Class IOHandler serves as the wrapper class for AbstractIOHandlerImpl objects
• LOG_AUD log error messages only
• LOG_L3 log first debug level, monitoring and error messages
• LOG_L4 log second and first debug level, monitoring and error messages
• LOG_L5 log third, 2nd and 1st debug level, monitoring and error messages
• LOG_MON log monitoring and error messages
• Policy Class Policy serves as the wrapper class for PolicyImpl objects
• PolicyContext Safe wrapper around code>PolicyContextImpl
• PolicyFileName Policy certificate file names and resource info file names
• PUSHBACK_SIZE A SocketInBuffer is a particular type of stream buffer for sockets in the input buffer
• SchemaValidation Validation of xml certificates, requests, and responses defaults to on
• ServerCertFile SSL params
• SSLMode SSLMode defaults to on

Enums, Unions, Structs

• SecurityConstants A structure to define constants used by the security provider
• SSLConstants A structure to define the constants used by the security provider
• TokenType TokenType
• Util This class provides a collection of static methods

hierarchy of classes

---

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de