What is Included in the C SDK?

Each library contains header files, samples, and README files containing information on how to implement the C SDK. More information is in the following sections.

• Header Files

• Code Samples

Header Files

A header file is a text file that contains pieces of code written in the C programming language. The name of a header file, by convention, ends with the .h extension. It is inserted inside a program by coding the #include preprocessor directive. The OpenSSO Enterprise C header files are:

<am.h>

General utility routines provided by the OpenSSO Enterprise library.

<am_auth.h>

Data types and functions for developing custom authentication modules.

<am_log.h>

Data types and functions for logging on the local system or the OpenSSO Enterprise host.

<am_map.h>

Data types and functions for creating, destroying, and manipulating the map objects used by OpenSSO Enterprise.

<am_notify.h>

Data types and functions for implementing notifications.

<am_policy.h>

Data types and functions for using OpenSSO Enterprise policy objects.

<am_properties.h>

Data types and functions for property maps used by clients of the OpenSSO Enterprise client API.

<am_sso.h>

Data types and functions for implementing SSO.

<am_string_set.h>

Data types and functions for manipulating strings.

<am_types.h>

Common types and macros provided by OpenSSO Enterprise.

<am_utils.h>

Functions to encode/decode HTTP cookies.

<am_web.h>

Data types and functions intended for use by OpenSSO Enterprise web agents.

Code Samples

OpenSSO Enterprise provides code samples that demonstrate how you can use the API to connect C applications to the OpenSSO Enterprise framework. The code samples are:

am_auth_test.c

Demonstrates the basic usage of the authentication API used to login to an instance of OpenSSO Enterprise.

am_log_test.c

Demonstrates the basic usage of the logging API used to write a message to the OpenSSO Enterprise logs.

am_policy_test.c

Demonstrates the basic usage of the policy API to evaluate access for specified resources.

am_sso_test.c

Demonstrates the basic usage of the SSO API to perform session operations.

apache_agent.c

Demonstrates how to use the policy API to build a web agent for the Apache Web Server.

---

Caution –

This is a sample web agent and is not intended to serve as a web agent in a real deployment.

---

Makefile

Makefile for building the sample agent.

README.TXT

Provides detailed instructions for building and executing sample programs.

---

Note –

am_web_agent_test.c, referred to in this file, is no longer used.

---