[Home] [Help]
PACKAGE: SSOSDK.WWSEC_SSO_ENABLER
Source
1 package wwsec_sso_enabler
2 as
3 /* list of exceptions */
4
5 UNKNOWN_ERROR_EXCEPTION exception;
6 CONFIG_MISSING_EXCEPTION exception;
7 DUP_CONFIG_EXCEPTION exception;
8 ENCRYPTION_FAILED_EXCEPTION exception;
9 DECRYPTION_FAILED_EXCEPTION exception;
10 UNSUPPORTED_VERSION_EXCEPTION exception;
11 IPADDR_ERROR_EXCEPTION exception;
12 COOKIE_EXPIRED_EXCEPTION exception;
13 NULL_ATTRIBUTE_EXCEPTION exception;
14
15 /**
16 * Generate Redirect
17 *
18 * This function generates a redirect URL along with site2pstoretoken
19 * for sending authentication request to Oracle SSO Server
20 *
21 * @param p_lsnr_token => listener token
22 * @param p_url_requested => requested url
23 * @param p_url_cancel => cancel url
24 * @param p_forced_auth => forced authentication flag
25 * @return redirecturl => redirect url to the SSO Server
26 *
27 * @exception UNKNOWN_ERROR_EXCEPTION
28 * @exception CONFIG_MISSING_EXCEPTION
29 * @exception ENCRYPTION_FAILED_EXCEPTION
30 * @exception UNSUPPORTED_VERSION_EXCEPTION
31 */
32 function generate_redirect
33 (
34 p_lsnr_token in varchar2
35 , p_url_requested in varchar2
36 , p_url_cancel in varchar2
37 , p_forced_auth in boolean default false
38 ) return varchar2;
39
40
41 /**
42 * Parse URL cookie
43 *
44 * This procedure parses URL cookie received from SSO Server
45 * that contains authenticated userinformation
46 *
47 * @param p_lsnr_token => listener token
48 * @param p_enc_url_cookie => encrypted URL cookie
49 * @return p_url_requested => requested URL
50 * @return p_sso_username => authenticated SSO username
51 * @return p_sso_user_dn => authenticated SSO user DN
52 * @return p_sso_user_guid => authenticated SSO user GUID
53 * @return p_subscriber_name => subscriber name
54 * @return p_subscriber_dn => subscriber DN
55 * @return p_subscriber_guid => subscriber GUID
56 * @return p_user_ipaddress => ipaddress of the sso user's machine
57 * @return p_sso_timeremaining => remaining SSO session duration
58 * @return p_nls_language => language selection of sso user
59 * @return p_nls_territory => territory selection of sso user
60 *
61 * @exception UNKNOWN_ERROR_EXCEPTION
62 * @exception CONFIG_MISSING_EXCEPTION
63 * @exception DECRYPTION_FAILED_EXCEPTION
64 * @exception UNSUPPORTED_VERSION_EXCEPTION
65 * @exception IPADDR_ERROR_EXCEPTION
66 * @exception COOKIE_EXPIRED_EXCEPTION
67 */
68 procedure parse_url_cookie
69 (
70 p_lsnr_token in varchar2
71 , p_enc_url_cookie in varchar2
72 , p_url_requested out varchar2
73 , p_sso_username out varchar2
74 , p_sso_user_dn out varchar2
75 , p_sso_user_guid out varchar2
76 , p_subscriber_name out varchar2
77 , p_subscriber_dn out varchar2
78 , p_subscriber_guid out varchar2
79 , p_user_ipaddress out varchar2
80 , p_sso_timeremaining out number
81 , p_nls_language out varchar2
82 , p_nls_territory out varchar2
83 );
84
85
86 /**
87 * Get enabler configuration
88 *
89 * This procedure returns enabler configuratuion
90 *
91 * @param p_lsnr_token => listener token
92 * @return p_site_token => site token
93 * @return p_site_id => site token
94 * @return p_ls_login_url => login url of SSO Server
95 * @return p_ls_logout_url => Single Sign-Off URL of SSO Server
96 * @return p_url_cookie_version => url cookie version
97 * @return p_encryption_key => encryption key
98 * @return p_ipaddr_check => if ip address should be verified or not
99 *
100 * @exception UNKNOWN_ERROR_EXCEPTION
101 * @exception CONFIG_MISSING_EXCEPTION
102 */
103 procedure get_enabler_config
104 (
105 p_lsnr_token in varchar2,
106 p_site_token out varchar2,
107 p_site_id out varchar2,
108 p_ls_login_url out varchar2,
109 p_ls_logout_url out varchar2,
110 p_url_cookie_version out varchar2,
111 p_encryption_key out varchar2,
112 p_ipaddr_check out varchar2
113 );
114
115
116 /**
117 * Create enabler configuration
118 *
119 * This procedure creates enabler configuratuion
120 *
121 * @param p_lsnr_token => listener token
122 * @param p_site_token => site token
123 * @param p_site_id => site token
124 * @param p_ls_login_url => login url of SSO Server
125 * @param p_ls_logout_url => Single Sign-Off URL of SSO Server
126 * @param p_url_cookie_version => url cookie version
127 * @param p_encryption_key => encryption key
128 * @param p_ipaddr_check => if ip address should be verified or not
129 *
130 * @exception UNKNOWN_ERROR_EXCEPTION
131 * @exception DUP_CONFIG_EXCEPTION
132 * @exception NULL_ATTRIBUTE_EXCEPTION
133 */
134 procedure create_enabler_config
135 (
136 p_lsnr_token in varchar2,
137 p_site_token in varchar2,
138 p_site_id in varchar2,
139 p_ls_login_url in varchar2,
140 p_ls_logout_url in varchar2,
141 p_url_cookie_version in varchar2,
142 p_encryption_key in varchar2,
143 p_ipaddr_check in varchar2
144 );
145
146 /**
147 * Modify enabler configuration
148 *
149 * This procedure modifies existing enabler configuratuion
150 *
151 * @param p_lsnr_token => listener token
152 * @param p_site_token => site token
153 * @param p_site_id => site token
154 * @param p_ls_login_url => login url of SSO Server
155 * @param p_ls_logout_url => Single Sign-Off URL of SSO Server
156 * @param p_url_cookie_version => url cookie version
157 * @param p_encryption_key => encryption key
158 * @param p_ipaddr_check => if ip address should be verified or not
159 *
160 * @exception UNKNOWN_ERROR_EXCEPTION
161 * @exception CONFIG_MISSING_EXCEPTION
162 */
163 procedure modify_enabler_config
164 (
165 p_lsnr_token in varchar2,
166 p_site_token in varchar2,
167 p_site_id in varchar2,
168 p_ls_login_url in varchar2,
169 p_ls_logout_url in varchar2,
170 p_url_cookie_version in varchar2,
171 p_encryption_key in varchar2,
172 p_ipaddr_check in varchar2
173 );
174
175 /**
176 * Delete enabler configuration
177 *
178 * This function deletes enabler configuratuion
179 *
180 * @param p_lsnr_token => listener token
181 *
182 * @exception UNKNOWN_ERROR_EXCEPTION
183 * @exception CONFIG_MISSING_EXCEPTION
184 */
185 procedure delete_enabler_config
186 (
187 p_lsnr_token in varchar2
188 );
189
190 /**
191 * Encrypt application cookie
192 *
193 * This function returns encrypted cookie body
194 *
195 * @param p_lsnr_token => listener token
196 * @param p_cookie => cookie value to be encrypted
197 *
198 * @exception UNKNOWN_ERROR_EXCEPTION
199 * @exception CONFIG_MISSING_EXCEPTION
200 * @exception ENCRYPTION_FAILED_EXCEPTION
201 */
202 function encrypt_cookie
203 (
204 p_lsnr_token in varchar2,
205 p_cookie in varchar2
206 ) return varchar2;
207
208 /**
209 * Decrypt application cookie
210 *
211 * This function retruns decrypted cookie value from
212 * encrypted cookie
213 *
214 * @param p_lsnr_token => listener token
215 * @param p_cookie => cookie value to be decrypted
216 *
217 * @exception UNKNOWN_ERROR_EXCEPTION
218 * @exception CONFIG_MISSING_EXCEPTION
219 * @exception DECRYPTION_FAILED_EXCEPTION
220 */
221 function decrypt_cookie
222 (
223 p_lsnr_token in varchar2,
224 p_enc_cookie in varchar2
225 ) return varchar2;
226
227
228 end wwsec_sso_enabler;