Oracle iPlanet Web Proxy Server 4.0.14 NSAPI Developer's Guide


A

	AddLog
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	API funct ( )

	API functions
		cache_digest ( )
		cache_filename ( )
		cache_fn_to_dig ( )
		CALLOC ( )
		ce_free ( )
		ce_lookup ( )
		cif_write_entry ( )
		cinfo_find ( )
		condvar_init ( )
		condvar_notify ( )
		condvar_terminate ( )
		condvar_wait ( )
		crit_enter ( )
		crit_exit ( )
		crit_init ( )
		crit_terminate ( )
		daemon_atrestart ( )
		fc_close ( )
		filebuf_buf2sd ( ) ( )
		filebuf_close ( )
		filebuf_getc ( )
		filebuf_open ( )
		filebuf_open_nostat ( )
		filter_create ( )
		filter_find ( )
		filter_insert ( )
		filter_layer ( )
		filter_name ( )
		filter_remove ( )
		flush ( )
		FREE ( )
		fs_blk_size ( )
		fs_blks_available ( )
		func_exec ( )
		func_find ( )
		func_insert ( )
		insert ( )
		log_error ( )
		magnus_atrestart ( )
		MALLOC ( )
		net_ip2host ( )
		net_read ( )
		net_write ( )
		netbuf_buf2sd ( )
		netbuf_close ( )
		netbuf_getc ( )
		netbuf_grab ( )
		netbuf_open ( )
		param_create ( )
		param_free ( )
		pblock_copy ( )
		pblock_create ( )
		pblock_dup ( )
		pblock_find ( )
		pblock_findlong ( )
		pblock_findval ( )
		pblock_free ( )
		pblock_nlinsert ( )
		pblock_nninsert ( )
		pblock_nvinsert ( )
		pblock_pb2env ( )
		pblock_pblock2str ( )
		pblock_pinsert ( )
		pblock_remove ( )
		pblock_replace_name ( )
		pblock_str2pblock ( )
		PERM_FREE ( )
		PERM_MALLOC ( ) ( ) ( )
		PERM_STRDUP ( )
		prepare_nsapi_thread ( )
		protocol_dump822 ( )
		protocol_set_finfo ( )
		protocol_start_response ( )
		protocol_status ( )
		protocol_uri2url ( ) ( )
		read ( )
		REALLOC ( )
		remove ( )
		request_create ( )
		request_free ( )
		request_header ( )
		sem_grab ( )
		sem_init ( )
		sem_release ( )
		sem_terminate ( )
		sem_tgrab ( )
		sendfile ( )
		session_create ( )
		session_dns ( )
		session_free ( )
		session_maxdns ( )
		shem_alloc ( )
		shexp_cmp ( )
		shexp_match ( )
		shexp_valid ( )
		shmem_free ( )
		STRDUP ( )
		system_errmsg ( )
		system_fclose ( )
		system_flock ( )
		system_fopenRO ( )
		system_fopenRW ( )
		system_fopenWA ( )
		system_fread ( )
		system_fwrite ( )
		system_fwrite_atomic ( )
		system_gmtime ( )
		system_localtime ( )
		system_lseek ( )
		system_rename ( )
		system_ulock ( ) ( ) ( )
		system_unix2local ( )
		systhread_attach ( )
		systhread_current ( )
		systhread_getdata ( )
		systhread_newkey ( ) ( )
		systhread_setdata ( )
		systhread_sleep ( )
		systhread_start ( )
		systhread_terminate ( )
		systhread_timerset ( ) ( )
		util_can_exec ( )
		util_chdir2path ( )
		util-cookie_find ( )
		util_cookie_find ( )
		util-does_process_exist ( )
		util_env_create ( )
		util_env_find ( )
		util_env_free ( )
		util_env_replace ( )
		util_env_str ( )
		util_get_current_gmt ( )
		util_get_int_from_file ( )
		util_get_long_from_file ( )
		util_get_string_from_file ( )
		util_getline ( )
		util_hostname ( )
		util_is_mozilla ( )
		util_is_url ( )
		util_itoa ( )
		util_later_than ( )
		util_make_filename ( )
		util_make_gmt ( )
		util_make_local ( )
		util_move_dir ( )
		util_move_file ( )
		util_parse_http_time ( )
		util_put_int_to_file ( )
		util_put_long_to_file ( )
		util_put_string_to_file ( )
		util_sect_id ( )
		util_sh_escape ( )
		util_snprintf ( )
		util-sprintf ( )
		util_strcasecmp ( )
		util_strftime ( )
		util_strncasecmp ( )
		util_uri_escape ( )
		util_uri_is_evil ( )
		util_uri_parse ( )
		util_uri_unescape ( )
		util_url_fix_hosthame ( ) ( )
		util_vsnprintf ( )
		util_vsprintf ( )
		write ( )
		writev ( )

	AUTH_TYPE environment variable ( )

	AUTH_USER environment variable ( )

	AuthTrans
		example of custom SAF ( )
		requirements for SAFs ( ) ( )


B

	buffered streams ( )


C

	cache_digest, API function ( )

	cache_filename, API function ( )

	cache_fn_to_dig, API function ( )

	CALLOC API function ( )

	ce_free, API function ( )

	ce_lookup, API function ( )

	CGI
		environment variables in NSAPI ( )
		to NSAPI conversion ( )

	chunked encoding ( ) ( )

	cif_write_entry, API function ( )

	cinfo_find API function ( )

	cinfo NSAPI data structure ( )

	client
		field in session parameter ( )
		getting DNS name for ( )
		getting IP address for ( )
		sessions and ( )

	CLIENT_CERT environment variable ( )

	compatibility issues ( ) ( )

	compiling custom SAFs ( )

	condvar_init API function ( )

	condvar_notify API function ( )

	condvar_terminate API function ( )

	condvar_wait API function ( )

	CONTENT_LENGTH environment variable ( )

	CONTENT_TYPE environment variable ( )

	context->data ( )

	context->rq ( )

	context->sn ( )

	creating
		custom filters ( )
		custom NSAPI plugins ( )

	crit_enter API function ( )

	crit_exit API function ( )

	crit_init API function ( )

	crit_terminate API function ( )

	csd field in session parameter ( )

	custom, NSAPI plugins ( )


D

	daemon_atrestart API function ( )

	data structures
		cinfo ( )
		compatibility issues ( )
		Filter ( )
		FilterContext ( )
		FilterLayer ( )
		FilterMethods ( )
		nsapi.h header file ( )
		nsapi_pvt.h ( )
		pb_entry ( )
		pb_param ( )
		pblock ( )
		privatization of ( )
		removed from nsapi.h ( )
		request ( )
		sendfiledata ( )
		session ( )
		Session->client ( )
		shmem_s ( )
		stat ( )

	day of month ( )

	DNS names, getting clients ( )


E

	environment variables, CGI to NSAPI conversion ( )

	Error directive
		requirements for SAFs ( ) ( )

	errors, finding most recent system error ( )

	examples
		location in the build ( )
		of custom SAFs in the build ( )
		wildcard patterns ( )


F

	fc_close API function ( )

	features, Proxy Server ( )

	file descriptor
		closing ( )
		locking ( )
		opening read-only ( )
		opening read-write ( )
		opening write-append ( )
		reading into a buffer ( )
		unlocking ( ) ( ) ( )
		writing from a buffer ( )
		writing without interruption ( )

	file I/O routines ( )

	filebuf_buf2sd API function ( ) ( )

	filebuf_close API function ( )

	filebuf_getc API function ( )

	filebuf_open API function ( )

	filebuf_open_nostat API function ( )

	filter_create API function ( )

	filter_find API function ( )

	filter_insert API function ( )

	filter_layer API function ( )

	filter methods ( )
		C prototypes for ( )
		FilterLayer data structure ( )
		flush ( )
		insert ( )
		remove ( )
		sendfile ( )
		write ( )
		writev ( )

	filter_name API function ( )

	Filter NSAPI data structure ( )

	filter_remove API function ( )

	FilterContext NSAPI data structure ( )

	FilterLayer NSAPI data structure ( ) ( )
		context->data ( )
		context->rq ( )
		context->sn ( )
		lower ( )

	FilterMethods NSAPI data structure ( )

	filters
		altering Content-length ( )
		functions used to implement ( )
		input ( )
		interface ( )
		methods ( )
		NSAPI function overview ( )
		output ( )
		stack position ( )
		using ( )

	flush API function ( ) ( )

	FREE API function ( )

	fs_blk_size, API function ( )

	fs_blks_available, API function ( )

	func_exec API function ( )

	func_find API function ( )

	func_insert API function ( )

	funcs parameter ( )


G

	GATEWAY_INTERFACE environment variable ( )

	GMT time, getting thread-safe value ( )


H

	headers
		field in request parameter ( )
		request ( )
		response ( )

	HOST environment variable ( )

	HTTP
		buffered streams ( )
		compliance with HTTP/1.1 ( )
		HTTP/1.1 specification ( )
		overview ( )
		requests ( )
		responses ( )
		status codes ( )

	HTTP_* environment variable ( )

	HTTPS environment variable ( )

	HTTPS_KEYSIZE environment variable ( )

	HTTPS_SECRETKEYSIZE environment variable ( )


I

	IETF home page ( )

	include directory, for SAFs ( )

	Init SAFs in magnus.conf
		requirements for SAFs ( ) ( )

	initializing
		plugins ( )
		SAFs ( )

	Input
		requirements for SAFs ( ) ( )

	input filters ( )

	insert API function ( ) ( )

	IP address, getting client’ ( )


K

	known issues, more information about ( )


L

	layer parameter ( )

	linking SAFs ( )

	load-modules function, example ( )

	loading
		custom SAFs ( )
		plugins ( )
		SAFs ( )

	localtime, getting thread-safe value ( )

	log_error API function ( )


M

	magnus_atrestart, API function ( )

	MALLOC API function ( )

	matching, special characters ( )

	memory management routines ( )

	month name ( )


N

	NameTrans
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	net_ip2host API function ( )

	net_read API function ( )

	net_write API function ( )

	netbuf_buf2sd API function ( )

	netbuf_close API function ( )

	netbuf_getc API function ( )

	netbuf_grab API function ( )

	netbuf_open API function ( )

	network I/O routines ( )

	new features, Proxy Server ( )

	NSAPI
		CGI environment variables ( )
		filter interface ( )
		function overview ( )

	NSAPI filters
		interface ( )
		methods ( )

	nsapi.h ( )

	NSAPI plugins, custom ( )

	nsapi_pvt.h ( )


O

	obj.conf, adding directives for new SAFs ( )

	ObjectType
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	order, of filters in filter stack ( )

	Output
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	output filters ( )


P

	param_create API function ( )

	param_free API function ( )

	parameter block
		manipulation routines ( )
		SAF parameter ( )

	parameters, for SAFs ( )

	PATH_INFO environment variable ( )

	path name, converting UNIX-style to local ( )

	PATH_TRANSLATED environment variable ( )

	PathCheck
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	pb_entry NSAPI data structure ( )

	pb_param NSAPI data structure ( )

	pb SAF parameter ( )

	pblock, NSAPI data structure ( )

	pblock_copy API function ( )

	pblock_create API function ( )

	pblock_dup API function ( )

	pblock_find API function ( )

	pblock_findlong, API function ( )

	pblock_findval API function ( )

	pblock_free API function ( )

	pblock_nlinsert, API function ( )

	pblock_nninsert API function ( )

	pblock_nvinsert API function ( )

	pblock_pb2env API function ( )

	pblock_pblock2str API function ( )

	pblock_pinsert API function ( )

	pblock_remove API function ( )

	pblock_replace_name, API function ( )

	pblock_str2pblock API function ( )

	PERM_FREE API function ( )

	PERM_MALLOC API function ( ) ( ) ( )

	PERM_STRDUP API function ( )

	platforms, supported ( )

	plugins
		compatibility issues ( ) ( )
		creating ( )
		instructing the server to use ( )
		loading and initializing ( )
		private data structures ( )

	prepare_nsapi_thread API function ( )

	private data structures ( )

	protocol_dump822 API function ( )

	protocol_set_finfo API function ( )

	protocol_start_response API function ( )

	protocol_status API function ( )

	protocol_uri2url API function ( ) ( )

	protocol utility routines ( )

	Proxy Server, features ( )


Q

	QUERY environment variable ( )

	QUERY_STRING environment variable ( )


R

	read API function ( ) ( )

	REALLOC API function ( )

	Release Notes ( )

	REMOTE_ADDR environment variable ( )

	REMOTE_HOST environment variable ( )

	REMOTE_IDENT environment variable ( )

	REMOTE_USER environment variable ( )

	remove API function ( ) ( )

	replace.c ( )

	REQ_ABORTED response code ( )

	REQ_EXIT response code ( )

	REQ_NOACTION response code ( )

	REQ_PROCEED response code ( )

	reqpb, field in request parameter ( )

	request
		NSAPI data structure ( )
		SAF parameter ( )

	request_create, API function ( )

	request_free, API function ( )

	request-handling process ( )

	request_header API function ( )

	request headers ( )

	REQUEST_METHOD environment variable ( )

	request-response model ( )

	requests, HTTP ( )

	requirements for SAFs ( )
		AddLog ( )
		AuthTrans ( )
		Error directive ( )
		Init ( )
		Input ( )
		NameTrans ( )
		ObjectType ( )
		Output ( )
		PathCheck ( )
		Service ( )

	response headers ( )

	responses, HTTP ( )

	result codes ( )

	rq->headers ( )

	rq->reqpb ( )

	rq->srvhdrs ( )

	rq->vars ( )

	rq SAF parameter ( )


S

	s ( )

	SAFs
		compiling and linking ( )
		include directory ( )
		interface ( )
		loading and initializing ( )
		parameters ( )
		result codes ( )
		return values ( )
		signature ( )
		testing ( )

	SCRIPT_NAME environment variable ( )

	sem_grab, API function ( )

	sem_init, API function ( )

	sem_release, API function ( )

	sem_terminate, API function ( )

	sem_tgrab, API function ( )

	semaphore
		creating ( )
		deallocating ( )
		gaining exclusive access ( )
		releasing ( )
		testing for exclusive access ( )

	sendfile API function ( ) ( )

	sendfiledata NSAPI data structure ( )

	server, instructions for using plugins ( )

	SERVER_NAME environment variable ( )

	SERVER_PORT environment variable ( )

	SERVER_PROTOCOL environment variable ( )

	SERVER_SOFTWARE environment variable ( )

	SERVER_URL environment variable ( )

	Service
		directives for new SAFs (plugins) ( )
		example of custom SAF ( )
		requirements for SAFs ( ) ( )

	session
		defined ( )
		NSAPI data structure ( )
		resolving the IP address of ( ) ( )

	Session->client NSAPI data structure ( )

	session_create, API function ( )

	session_dns API function ( )

	session_free, API function ( )

	session_maxdns API function ( )

	session SAF parameter ( )

	session structure
		creating ( )
		freeing ( )

	shared memory
		allocating ( )
		freeing ( )

	shell expression
		comparing (case-sensitive) to a string ( ) ( )
		validating ( )

	shexp_casecmp API function ( )

	shexp_cmp API function ( )

	shexp_match API function ( )

	shexp_valid API function ( )

	shlib parameter ( )

	shmem_alloc, API function ( )

	shmem_free, API function ( )

	shmem_s NSAPI data structure ( )

	sn->client ( )

	sn->csd ( )

	sn SAF parameter ( )

	socket
		closing ( )
		reading from ( )
		sending a buffer to ( )
		sending file buffer to ( )
		writing to ( )

	sprintf, see util_sprintf ( )

	srvhdrs, field in request parameter ( )

	stat NSAPI data structure ( )

	status codes ( )

	STRDUP API function ( )

	streams, buffered ( )

	string, creating a copy of ( )

	supported platforms ( )

	system_errmsg API function ( )

	system_fclose API function ( )

	system_flock API function ( )

	system_fopenRO API function ( )

	system_fopenRW API function ( )

	system_fopenWA API function ( )

	system_fread API function ( )

	system_fwrite API function ( )

	system_fwrite_atomic API function ( )

	system_gmtime API function ( )

	system_localtime API function ( )

	system_lseek API function ( )

	system_rename API function ( )

	system requirements ( )

	system_ulock API function ( ) ( ) ( )

	system_unix2local API function ( )

	systhread_attach API function ( )

	systhread_current API function ( )

	systhread_getdata API function ( )

	systhread_newkey, API function ( )

	systhread_newkey API function ( )

	systhread_setdata API function ( )

	systhread_sleep API function ( )

	systhread_start API function ( )

	systhread_terminate, API function ( )

	systhread_timerset, API function ( )

	systhread_timerset API function ( )


T

	testing custom SAFs ( )

	thread
		allocating a key for ( ) ( )
		creating ( )
		getting a pointer to ( )
		getting data belonging to ( )
		putting to sleep ( )
		setting data belonging to ( )
		setting interrupt timer ( ) ( )
		terminating ( )

	thread routines ( )


U

	unicode ( ) ( )

	util_can_exec API function ( )

	util_chdir2path API function ( )

	util_cookie_find API function ( ) ( )

	util_does_process_exist, API function ( )

	util_env_create, API function ( )

	util_env_find API function ( )

	util_env_free API function ( )

	util_env_replace API function ( )

	util_env_str API function ( )

	util_get_current_gmt, API function ( )

	util_get_int_from_file, API function ( )

	util_get_long_from_file, API function ( )

	util_get_string_from_file, API function ( )

	util_getline API function ( )

	util_hostname API function ( )

	util_is_mozilla API function ( )

	util_is_url API function ( )

	util_itoa API function ( )

	util_later_than API function ( )

	util_make_filename, API function ( )

	util_make_gmt, API function ( )

	util_make_local, API function ( )

	util_move_dir, API function ( )

	util_move_file, API function ( )

	util_parse_http_time, API function ( )

	util_put_int_to_file, API function ( )

	util_put_long_to_file, API function ( )

	util_put_string_to_file, API function ( )

	util_sect_id, API function ( )

	util_sh_escape API function ( )

	util_snprintf API function ( )

	util_sprintf API function ( )

	util_strcasecmp API function ( )

	util_strftime API function ( ) ( )

	util_strncasecmp API function ( )

	util_uri_escape API function ( )

	util_uri_is_evil API function ( )

	util_uri_parse API function ( )

	util_uri_unescape API function ( )

	util_url_fix_hostname
		API function ( ) ( )

	util_vsnprintf API function ( )

	util_vsprintf API function ( )

	utility routines ( )


V

	vars, field in request parameter ( )

	vsnprintf, see util_vsnprintf ( )

	vsprintf, see util_vsprintf ( )


W

	weekday ( )

	workarounds, more information about ( )

	write API function ( ) ( )

	writev API function ( ) ( )