1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* Copyright (C) 2012 Intel Corporation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file ewk_auth_request.h
* @brief Describes the Ewk Authentication Request API.
*/
#ifndef ewk_auth_request_h
#define ewk_auth_request_h
#include <Eina.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* Declare Ewk_Auth_Request as Ewk_Object.
*
* @see Ewk_Object
*/
typedef struct EwkObject Ewk_Auth_Request;
/**
* Queries the suggested username to be used for authenticating.
*
* @param request request object to query
*
* @return the username pointer, that may be @c NULL. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_auth_request_suggested_username_get(const Ewk_Auth_Request *request);
/**
* Queries if this an authentication attempt retrying.
*
* @param request request object to query
*
* @return @c EINA_TRUE if this is not the first authentication attempt
* and we are trying, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_auth_request_retrying_get(const Ewk_Auth_Request *request);
/**
* Queries the authentication realm.
*
* @param request request object to query
*
* @return the realm pointer, that may be @c NULL. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_auth_request_realm_get(const Ewk_Auth_Request *request);
/**
* Queries the host requiring the authentication.
*
* @param request request object to query
*
* @return the host pointer, that may be @c NULL. This pointer is
* guaranteed to be eina_stringshare, so whenever possible
* save yourself some cpu cycles and use
* eina_stringshare_ref() instead of eina_stringshare_add() or
* strdup()
*/
EAPI const char *ewk_auth_request_host_get(const Ewk_Auth_Request *request);
/**
* Cancels the authentication request.
*
* @param request request object to cancel
*
* @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise
*/
EAPI Eina_Bool ewk_auth_request_cancel(Ewk_Auth_Request *request);
/**
* Set credential for the authentication request.
*
* @param request request object to update
*
* @return @c EINA_TRUE if the credential was successfuly sent, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ewk_auth_request_authenticate(Ewk_Auth_Request *request, const char *username, const char *password);
#ifdef __cplusplus
}
#endif
#endif /* ewk_auth_request_h */
|
