Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:
Select Section of Man Page:
Select Man Page Repository:
apropos Keyword Search (sections above)

OpenSolaris 2009.06 - man page for ne_set_server_auth (opensolaris section 3)

NE_SET_SERVER_AUTH(3)			neon API reference		    NE_SET_SERVER_AUTH(3)

NAME
       ne_set_server_auth, ne_set_proxy_auth, ne_forget_auth - register authentication callbacks

SYNOPSIS
       #include <ne_auth.h>

       typedef int (*ne_request_auth) (void *userdata, const char *realm, int attempt,
					char *username, char *password);

       void ne_set_server_auth (ne_session *session, ne_request_auth callback, void *userdata);

       void ne_set_proxy_auth (ne_session *session, ne_request_auth callback, void *userdata);

       void ne_forget_auth (ne_session *session);

DESCRIPTION
       The ne_request_auth function type defines a callback which is invoked  when  a  server  or
       proxy  server  requires	user authentication for a particular request. The realm string is
       supplied by the server.	The attempt is a counter giving the number of times  the  request
       has been retried with different authentication credentials. The first time the callback is
       invoked for a particular request, attempt will be zero.

       To retry the request using new authentication credentials, the callback should return  ze-
       ro,  and  the  username	and  password  buffers	must  contain NUL-terminated strings. The
       NE_ABUFSIZ constant gives the size of these buffers.

	      Tip

	      If you only wish to allow the user one attempt to enter credentials, use the  value
	      of the attempt parameter as the return value of the callback.

       To  abort the request, the callback should return a non-zero value; in which case the con-
       tents of the username and password buffers are ignored.

       The ne_forget_auth function can be used to discard the cached authentication credentials.

EXAMPLES
       /* Function which prompts for a line of user input: */
       extern char *prompt_for(const char *prompt);

       static int
       my_auth(void *userdata, const char *realm, int attempts,
	       char *username, char *password)
       {
	  strncpy(username, prompt_for("Username: "), NE_ABUFSIZ);
	  strncpy(password, prompt_for("Password: "), NE_ABUFSIZ);
	  return attempts;
       }

       int main(...)
       {
	  ne_session *sess = ne_session_create(...);

	  ne_set_server_auth(sess, my_auth, NULL);

	  /* ... */
       }

AUTHOR
       Joe Orton <neon@webdav.org>.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +--------------------+-----------------+
       |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
       +--------------------+-----------------+
       |Availability	    | SUNWneon	      |
       +--------------------+-----------------+
       |Interface Stability | Volatile	      |
       +--------------------+-----------------+
NOTES
       Source for Neon is available on http://opensolaris.org.

neon 0.25.5				 20 January 2006		    NE_SET_SERVER_AUTH(3)


All times are GMT -4. The time now is 11:38 AM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
×
UNIX.COM Login
Username:
Password:  
Show Password





Not a Forum Member?
Forgot Password?