Qpid Proton C API  0.18.0
sasl.h
Go to the documentation of this file.
1 #ifndef PROTON_SASL_H
2 #define PROTON_SASL_H 1
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include <proton/import_export.h>
26 #include <proton/type_compat.h>
27 #include <proton/types.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
49 typedef struct pn_sasl_t pn_sasl_t;
50 
54 typedef enum {
55  PN_SASL_NONE = -1,
56  PN_SASL_OK = 0,
62 
74 PN_EXTERN pn_sasl_t *pn_sasl(pn_transport_t *transport);
75 
88 PN_EXTERN bool pn_sasl_extended(void);
89 
97 PN_EXTERN void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome);
98 
105 
123 PN_EXTERN const char *pn_sasl_get_user(pn_sasl_t *sasl);
124 
134 PN_EXTERN const char *pn_sasl_get_mech(pn_sasl_t *sasl);
135 
145 PN_EXTERN void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs);
146 
164 PN_EXTERN void pn_sasl_set_allow_insecure_mechs(pn_sasl_t *sasl, bool insecure);
165 
171 PN_EXTERN bool pn_sasl_get_allow_insecure_mechs(pn_sasl_t *sasl);
172 
185 PN_EXTERN void pn_sasl_config_name(pn_sasl_t *sasl, const char *name);
186 
202 PN_EXTERN void pn_sasl_config_path(pn_sasl_t *sasl, const char *path);
203 
208 #ifdef __cplusplus
209 }
210 #endif
211 
212 #endif /* sasl.h */
AMQP and API data types.
void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs)
SASL mechanisms that are to be considered for authentication.
struct pn_transport_t pn_transport_t
A network channel supporting an AMQP connection.
Definition: types.h:431
failed due to bad credentials
Definition: sasl.h:58
pn_sasl_t * pn_sasl(pn_transport_t *transport)
Construct an Authentication and Security Layer object.
void pn_sasl_set_allow_insecure_mechs(pn_sasl_t *sasl, bool insecure)
Boolean to allow use of clear text authentication mechanisms.
const char * pn_sasl_get_user(pn_sasl_t *sasl)
Retrieve the authenticated user.
authentication succeeded
Definition: sasl.h:57
failed due to unrecoverable error
Definition: sasl.h:60
pn_sasl_outcome_t
The result of the SASL negotiation.
Definition: sasl.h:54
bool pn_sasl_get_allow_insecure_mechs(pn_sasl_t *sasl)
Return the current value for allow_insecure_mechs.
failed due to a system error
Definition: sasl.h:59
void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome)
Set the outcome of SASL negotiation.
negotiation not completed
Definition: sasl.h:56
void pn_sasl_config_name(pn_sasl_t *sasl, const char *name)
Set the sasl configuration name.
const char * pn_sasl_get_mech(pn_sasl_t *sasl)
Return the selected SASL mechanism.
pn_sasl_outcome_t pn_sasl_outcome(pn_sasl_t *sasl)
Retrieve the outcome of SASL negotiation.
void pn_sasl_config_path(pn_sasl_t *sasl, const char *path)
Set the sasl configuration path.
bool pn_sasl_extended(void)
Do we support extended SASL negotiation.
struct pn_sasl_t pn_sasl_t
The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over which AM...
Definition: sasl.h:49