dsapi_bindparams.h

Go to the documentation of this file.

/* Emacs mode: -*- C -*- */
 
/*
 * Copyright (c) 2009-2021, Isode Limited, London, England.
 * All rights reserved.
 *
 * Acquisition and use of this software and related materials for any
 * purpose requires a written licence agreement from Isode
 * Limited, or a written licence from an organisation licenced by Isode
 * Limited to grant such a licence.
 */
 
/*
 * dsapi_bindparams.h
 *
 * Isode-internal API methods for handling a structure used to hold
 * bind parameters.
 */
 
#ifndef ISODE_DSAPI_BINDPARAMS_H
#define ISODE_DSAPI_BINDPARAMS_H
 
#include <stddef.h>
#include <sys/stat.h>
#include <isode/ds/dsapi/dsapi_cdecl.h>
#include <isode/ds/dsapi/dsapi_types.h>
#include <openssl/evp.h>
#include <isode/crypto/x509.h>
 
typedef enum {
    DSAnonymous = 0, 
    DSSimple = 1,    
    DSStrong = 2,    
    DSSASL = 3       
} DSBindType;
 
#define DS_SASL_BEST_SSF (65535)
 
#ifndef SWIG
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_New (
    DS_BindParams **params_p);
 
LIBDSAPI_CDECL
void DS_BindParams_Delete (
    DS_BindParams *params);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_Copy (
    const DS_BindParams *in,
    DS_BindParams **copy_p);
 
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_GetBindType (
    const DS_BindParams *params,
   DSBindType *bind_type);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetIdentity (
    DS_BindParams *params,
    const DS_Identity *id);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetCertificateServer (
    DS_BindParams *params,
    const char *ldap_host,
    long ldap_port,
    int check_crls);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_GetIdentity (
    const DS_BindParams *params,
    const DS_Identity **id_p);
 
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_GetCertificateServer (
    const DS_BindParams *params,
    const char **ldap_host,
    long        *ldap_port,
    int         *check_crls);
 
 
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetAnonymous (
    DS_BindParams *params);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetSimple (
    DS_BindParams *params,
    const DS_DN   *bind_dn,
    const char    *password);
 
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetStrong (
    DS_BindParams *params,
    const DS_Identity *id,
    const DS_DN   *dsa_dn);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetSASL (
    DS_BindParams        *params,
    const char           *sasl_mechs,
    const DS_SASLProps   *sasl_props,
    const char           *sasl_authentication,
    const char           *sasl_secret);
 
LIBDSAPI_CDECL
DS_Status DS_BindParams_SetSASLRealm (
    DS_BindParams        *params,
    const char           *sasl_realm);
 
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_New(
    DS_SASLProps       **props_p);
 
LIBDSAPI_CDECL
void DS_SASLProps_Delete(
    DS_SASLProps       *props);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_Copy(
    const DS_SASLProps *in,
    DS_SASLProps      **copy_p);
 
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetSSF (
    DS_SASLProps *props,
    int min_ssf,
    int max_ssf);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_GetSSF (
    const DS_SASLProps *props,
    int *min_ssf_p,
    int *max_ssf_p);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetMaxBufferSize (
    DS_SASLProps *props,
    int           maxbufsize
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetNoPlaintext (
    DS_SASLProps *props,
    int           noplain
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetNoActive (
    DS_SASLProps *props,
    int           noactive
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetNoDictionary (
    DS_SASLProps *props,
    int           nodict
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetForwardSecrecy (
    DS_SASLProps *props,
    int           forwardsec
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetNoAnonymous (
    DS_SASLProps *props,
    int           noanonymous
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetPassCredentials (
    DS_SASLProps *props,
    int           passcred
);
 
LIBDSAPI_CDECL
DS_Status DS_SASLProps_SetADcompat (
    DS_SASLProps *props,
    int enable);
 
#endif /* !SWIG */
 
#endif /* ISODE_DSAPI_BINDPARAMS_H */