Index of /pub/mirrors/ftp.novell.com/forge/ncslib

Icon  Name                               Last modified      Size  Description
[DIR] Parent Directory - [TXT] CHANGELOG.html 18-Feb-2005 17:51 6.2K [TXT] DEPENDENCIES.html 18-Feb-2005 17:51 2.4K [TXT] DOCUMENTATION.html 24-Jan-2005 00:00 132 [TXT] LICENSE.txt 01-Dec-2004 00:00 11K [TXT] README.html 09-Feb-2005 00:00 26K [TXT] SAMPLECODE.html 24-Jan-2005 00:00 132 [DIR] builds/ 27-Aug-2008 01:59 -
Novell Certificate Server Libraries for C


Novell Certificate Server Libraries for C

1.0 Overview
2.0 What's New
3.0 Documentation
4.0 System Requirements
4.1 PKIS
4.2 NPKI
4.3 NPKIT
4.4 JPKI (Early Access)
5.0 Common Problems
5.1 NPKI
5.2 JPKI
6.0 NPKI Linking Libraries
6.1 Using APIs with Windows as a Client
6.2 Using APIs with NetWare (Server) as a Client
7.0 Sample Code
8.0 Legal Notices


1.0 Overview

The Novell® Certificate ServerTM Libraries for C provide programmatic access to Novell Certificate Server. Certificate Server in an enterprise public key infrastructure (PKI) solution that offers the ability to freely mint an unlimited number of digital certificates for end-users (such as to enable secure e-mail or X.509 certificate-based authentication) and for servers (such as to enable SSL security).

Novell currently provides the following three C Certificate Server API libraries:

NOTE:  The Certificate Server Classes for Java (JPKI) is a Java-based API that provides all of the functionality of the C API. Because this is an Early Access component, JPKI is subject to change and should not be used in a production environment.

NPKI and NPKIT libraries, which supersede the original Novell Certificate Server Library (Version 1) (NWPKI), should be used together to provide the same functionality as the original API. NPKI and NPKIT should be used by all new applications, as well as existing applications that plan to use any of the new functionality.

Existing programs may retain backward compatibility by continuing to use the original NWPKI library. All future Certificate Server bug fixes and product enhancements will be incorporated into the new API libraries only.

NOTE:  Neither NPKI or NPKIT require the Novell Client.


2.0 What's New

Rolled in the latest version of the 2.72.1 software, which includes all bug fixes for future releases of the Certificate Server API. To see what was changed in the software, sample code, and documentation for previous releases, see the What's New archive.

To see the specific documentation changes that were made, see the Revision History.


3.0 Documentation

We've enabled Start menu documentation entries. After you have downloaded and installed the documentation, use the "NDK Documents" entry on your Start menu to quickly locate and access NDK documentation.

The documents in this download were created as standalone files; therefore, links between files in this download and links to files in other downloads will not resolve. To read or print the documentation, you need Adobe Acrobat Reader 4.0, a free download.

The download for each of the C and Java APIs includes a single documentation file in the [install directory]\\NDK\\doc\\ncslib directory:


4.0 System Requirements


4.1 PKIS

The Novell Certificate Server (Version 1) API service requires the operating system requirements described by Novell Certificate Server 2.0 System Requirements.


4.2 NPKI

The Novell Certificate Server API Version 2 (NPKI) service depends on the same operating system requirements as the Novell eDirectory 8.7.1 or above.


4.3 NPKIT

The Novell Public Key Infrastructure Toolbox (NPKIT) API service depends on the same operating system requirements as the Novell eDirectory 8.7.1 or above.


4.4 JPKI (Early Access)

The Certificate Server Classes for Java (Early Access) depends on the same operating system requirements as the Novell eDirectory 8.7.1 or above.


5.0 Common Problems


5.1 NPKI

When using the NPKI Certificate Server APIs it is important to remember that you must call NPKICreateContext and supply the acquired context to all subsequent calls. It is also important to call NPKIFreeContext when finished making calls to the API.

It is important to call NPKISetTreeName so that the API will contact the correct tree. Always call NPKIDSLogin after NPKISetTreeName.

When using the API from the server, it is necessary to call NPKIDSLogin, because there is not an identity for the API to take over.


5.2 JPKI

Because Certificate Server Classes for Java is an Early Access component, the functionality is subject to change and should not be used in a production environment.

NOTE:  Because Certificate Server components downloaded from the NDK typically are not placed in relative directories, Adobe PDF links between the Java and C Certificate Server NDK documentation do not resolve. However, HTML links do resolve properly when documentation is viewed on line.


6.0 NPKI Linking Libraries


6.1 Using APIs with Windows as a Client

The API functionality has been provided as a multi-threaded dynamic library. The library you will need to link to is: win32\\final\\npkiapi.lib.


6.2 Using APIs with NetWare (Server) as a Client

The API functionality is being provided in the library NLM: NPKIAPI.nlm.

You may wish to auto-load the NLM when your NLM loads. The import file is: inc\\npki.imp.


7.0 Sample Code

To view the available sample code files, see the Novell Certificate Server Libraries for C Sample Code Page.


8.0 Legal Notices

Novell, Inc. makes no representations or warranties with respect to the contents or use of this download, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time, without obligation to notify any person or entity of such revisions or changes.

Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to notify any person or entity of such changes.

You may not use, export, or re-export this product in violation of any applicable laws or regulations including, without limitation, U.S. export regulations or the laws of the country in which you reside.

All files provided in this release are subject to the Novell Developer License Agreement, which can be found in the license.txt file provided in this download.

Copyright © 2005 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher.

AppNotes is a registered trademark of Novell, Inc.

AppTester is a registered trademark of Novell, Inc. in the United States.

ASM is a trademark of Novell, Inc.

BorderManager is a registered trademark of Novell, Inc.

BrainShare is a registered service mark of Novell, Inc. in the United States and other countries.

C3PO is a trademark of Novell, Inc.

Certified Novell Engineer is a service mark of Novell, Inc.

Client32 is a trademark of Novell, Inc.

CNE is a registered service mark of Novell, Inc.

ConsoleOne is a registered trademark of Novell, Inc.

Controlled Access Printer is a trademark of Novell, Inc.

Custom 3rd-Party Object is a trademark of Novell, Inc.

DeveloperNet is a registered trademark of Novell, Inc. in the United States and other countries.

DirXML is a registered trademark of Novell, Inc.

eDirectory is a trademark of Novell, Inc.

Excelerator is a trademark of Novell, Inc.

exteNd is a trademark of Novell, Inc.

exteNd Director is a trademark of Novell, Inc.

exteNd Workbench is a trademark of Novell, Inc.

FAN-OUT FAILOVER is a trademark of Novell, Inc.

GroupWise is a registered trademark of Novell, Inc. in the United States and other countries.

Hardware Specific Module is a trademark of Novell, Inc.

Hot Fix is a trademark of Novell, Inc.

iChain is a registered trademark of Novell, Inc.

Internetwork Packet Exchange is a trademark of Novell, Inc.

IPX is a trademark of Novell, Inc.

IPX/SPX is a trademark of Novell, Inc.

jBroker is a trademark of Novell, Inc.

Link Support Layer is a trademark of Novell, Inc.

LSL is a trademark of Novell, Inc.

ManageWise is a registered trademark of Novell, Inc., in the United States and other countries.

Mirrored Server Link is a trademark of Novell, Inc.

Mono is a registered trademark of Novell, Inc.

MSL is a trademark of Novell, Inc.

My World is a registered trademark of Novell, Inc. in the United States.

NCP is a trademark of Novell, Inc.

NDPS is a registered trademark of Novell, Inc.

NDS is a registered trademark of Novell, Inc. in the United States and other countries.

NDS Manager is a trademark of Novell, Inc.

NE2000 is a trademark of Novell, Inc.

NetMail is a registered trademark of Novell, Inc.

NetWare is a registered trademark of Novell, Inc. in the United States and other countries.

NetWare/IP is a trademark of Novell, Inc.

NetWare Core Protocol is a trademark of Novell, Inc.

NetWare Loadable Module is a trademark of Novell, Inc.

NetWare Management Portal is a trademark of Novell, Inc.

NetWare Name Service is a trademark of Novell, Inc.

NetWare Peripheral Architecture is a trademark of Novell, Inc.

NetWare Requester is a trademark of Novell, Inc.

NetWare SFT and NetWare SFT III are trademarks of Novell, Inc.

NetWare SQL is a trademark of Novell, Inc.

NetWire is a registered service mark of Novell, Inc. in the United States and other countries.

NLM is a trademark of Novell, Inc.

NMAS is a trademark of Novell, Inc.

NMS is a trademark of Novell, Inc.

Novell is a registered trademark of Novell, Inc. in the United States and other countries.

Novell Application Launcher is a trademark of Novell, Inc.

Novell Authorized Service Center is a service mark of Novell, Inc.

Novell Certificate Server is a trademark of Novell, Inc.

Novell Client is a trademark of Novell, Inc.

Novell Cluster Services is a trademark of Novell, Inc.

Novell Directory Services is a registered trademark of Novell, Inc.

Novell Distributed Print Services is a trademark of Novell, Inc.

Novell iFolder is a registered trademark of Novell, Inc.

Novell Labs is a trademark of Novell, Inc.

Novell SecretStore is a registered trademark of Novell, Inc.

Novell Security Attributes is a trademark of Novell, Inc.

Novell Storage Services is a trademark of Novell, Inc.

Novell, Yes, Tested & Approved logo is a trademark of Novell, Inc.

Nsure is a registered trademark of Novell, Inc.

Nterprise is a trademark of Novell, Inc.

Nterprise Branch Office is a trademark of Novell, Inc.

ODI is a trademark of Novell, Inc.

Open Data-Link Interface is a trademark of Novell, Inc.

Packet Burst is a trademark of Novell, Inc.

PartnerNet is a registered service mark of Novell, Inc. in the United States and other countries.

Printer Agent is a trademark of Novell, Inc.

QuickFinder is a trademark of Novell, Inc.

Red Box is a trademark of Novell, Inc.

Red Carpet is a registered trademark of Novell, Inc. in the United States and other countries.

Sequenced Packet Exchange is a trademark of Novell, Inc.

SFT and SFT III are trademarks of Novell, Inc.

SPX is a trademark of Novell, Inc.

Storage Management Services is a trademark of Novell, Inc.

SUSE is a registered trademark of SUSE AG, a Novell business.

System V is a trademark of Novell, Inc.

Topology Specific Module is a trademark of Novell, Inc.

Transaction Tracking System is a trademark of Novell, Inc.

TSM is a trademark of Novell, Inc.

TTS is a trademark of Novell, Inc.

Universal Component System is a registered trademark of Novell, Inc.

Virtual Loadable Module is a trademark of Novell, Inc.

VLM is a trademark of Novell, Inc.

Yes Certified is a trademark of Novell, Inc.

ZENworks is a registered trademark of Novell, Inc. in the United States and other countries.

All third-party trademarks are the property of their respective owners.