sasl.h

Go to the documentation of this file.

#ifndef PROTON_SASL_H
#define PROTON_SASL_H 1
 
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
 
#include <proton/import_export.h>
#include <proton/type_compat.h>
#include <proton/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct pn_sasl_t pn_sasl_t;
 
typedef enum {
  PN_SASL_NONE = -1,  
  PN_SASL_OK = 0,     
  PN_SASL_AUTH = 1,   
  PN_SASL_SYS = 2,    
  PN_SASL_PERM = 3,   
  PN_SASL_TEMP = 4    
} pn_sasl_outcome_t;
 
PN_EXTERN pn_sasl_t *pn_sasl(pn_transport_t *transport);
 
PN_EXTERN bool pn_sasl_extended(void);
 
PN_EXTERN void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome);
 
PN_EXTERN pn_sasl_outcome_t pn_sasl_outcome(pn_sasl_t *sasl);
 
PN_EXTERN const char *pn_sasl_get_user(pn_sasl_t *sasl);
 
PN_EXTERN const char *pn_sasl_get_authorization(pn_sasl_t *sasl);
 
PN_EXTERN const char *pn_sasl_get_mech(pn_sasl_t *sasl);
 
PN_EXTERN void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs);
 
PN_EXTERN void pn_sasl_set_allow_insecure_mechs(pn_sasl_t *sasl, bool insecure);
 
PN_EXTERN bool pn_sasl_get_allow_insecure_mechs(pn_sasl_t *sasl);
 
PN_EXTERN void pn_sasl_config_name(pn_sasl_t *sasl, const char *name);
 
PN_EXTERN void pn_sasl_config_path(pn_sasl_t *sasl, const char *path);
 
#ifdef __cplusplus
}
#endif
 
#endif /* sasl.h */