/usr/share/ada/adainclude/aws/aws-client.ads is in libaws3.2.0-dev 3.2.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 | ------------------------------------------------------------------------------
-- Ada Web Server --
-- --
-- Copyright (C) 2000-2014, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify --
-- it under terms of the GNU General Public License as published by the --
-- Free Software Foundation; either version 3, or (at your option) any --
-- later version. This library is distributed in the hope that it will be --
-- useful, but WITHOUT ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- --
-- --
-- --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
-- --
-- --
-- --
-- --
-- --
-- --
------------------------------------------------------------------------------
pragma Ada_2012;
with Ada.Exceptions;
with Ada.Finalization;
with Ada.Real_Time;
with Ada.Streams;
with Ada.Strings.Unbounded;
with AWS.Attachments;
with AWS.Default;
with AWS.Headers;
with AWS.Net.SSL.Certificate;
with AWS.Response;
with AWS.URL;
with AWS.Utils;
with ZLib;
package AWS.Client is
use Ada.Streams;
Connection_Error : exception;
-- Raised if the connection with the server cannot be established
Protocol_Error : exception;
-- Raised if the client receives wrong HTTP protocol data
No_Data : constant String;
-- Used as the default parameter when no data specified for a specific
-- parameter.
Retry_Default : constant := 0;
-- Number of time a data is requested from the Server if the first
-- time fails.
--------------
-- Timeouts --
--------------
type Timeouts_Values is private;
-- Defined the duration for the connect, send, receive and complete
-- response receive timeouts.
No_Timeout : constant Timeouts_Values;
-- No timeout, allow infinite time to send or retrieve data
function Timeouts
(Connect : Duration := Net.Forever;
Send : Duration := Net.Forever;
Receive : Duration := Net.Forever;
Response : Duration := Net.Forever) return Timeouts_Values;
-- Constructor for the timeouts values
function Timeouts (Each : Duration) return Timeouts_Values;
-- Constructor for the timeouts values, sets all timeouts values (see
-- Contructor above) to Each.
function Connect_Timeout (T : Timeouts_Values) return Duration with Inline;
-- Returns the corresponding timeout value
function Send_Timeout (T : Timeouts_Values) return Duration with Inline;
-- Returns the corresponding timeout value
function Receive_Timeout (T : Timeouts_Values) return Duration with Inline;
-- Returns the corresponding timeout value
function Response_Timeout (T : Timeouts_Values) return Duration with Inline;
-- Returns the corresponding timeout value
--------------
-- Messages --
--------------
type Content_Bound is new Integer range -1 .. Integer'Last;
Undefined : constant Content_Bound := -1;
type Content_Range is record
First, Last : Content_Bound := Undefined;
end record;
-- Range for partial download
No_Range : constant Content_Range := (Undefined, Undefined);
type Authentication_Mode is new AWS.Response.Authentication_Mode;
type Authentication_Level is private;
type Authentication_Type is private;
type Auth_Attempts_Count is private;
subtype Header_List is Headers.List;
Empty_Header_List : constant Header_List := Headers.Empty_List;
subtype Attachment_List is Attachments.List;
Empty_Attachment_List : constant Attachment_List := Attachments.Empty_List;
function Get
(URL : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Data_Range : Content_Range := No_Range;
Follow_Redirection : Boolean := False;
Certificate : String := Default.Client_Certificate;
Headers : Header_List := Empty_Header_List)
return Response.Data;
-- Retrieve the message data given a specific URL. It open a connection
-- with the server and ask for the resource specified in the URL it then
-- return it in the Response.Data structure.
-- If User/Pwd are given then it uses it to access the URL.
--
-- Eventually it connect through a PROXY using if necessary the Proxy
-- authentication Proxy_User:Proxy_Pwd.
--
-- Only Basic authentication is supported (i.e. Digest is not). Digest
-- authentication is supported with the keep-alive client API, see below.
--
-- If Follow_Redirection is set to True, Get will follow the redirection
-- information for 301 status code response. Note that this is not
-- supported for keep-alive connections as the redirection could point to
-- another server.
--
-- Get will retry one time if it fails.
function Head
(URL : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Headers : Header_List := Empty_Header_List) return Response.Data;
-- Idem as above but we do not get the message body.
-- Head will retry one time if it fails.
function Put
(URL : String;
Data : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Headers : Header_List := Empty_Header_List) return Response.Data;
-- Send to the server URL a PUT request with Data
-- Put will retry one time if it fails.
function Post
(URL : String;
Data : String;
Content_Type : String := No_Data;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List)
return Response.Data;
-- Send to the server URL a POST request with Data
-- Post will retry one time if it fails.
function Post
(URL : String;
Data : Stream_Element_Array;
Content_Type : String := No_Data;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List)
return Response.Data;
-- Idem as above but with binary data
function SOAP_Post
(URL : String;
Data : String;
SOAPAction : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List) return Response.Data;
-- Send to the server URL a POST request with Data
-- Post will retry one time if it fails.
function Upload
(URL : String;
Filename : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Timeouts : Timeouts_Values := No_Timeout;
Headers : Header_List := Empty_Header_List;
Progress : access procedure
(Total, Sent : Stream_Element_Offset) := null)
return Response.Data;
-- This is a file upload request. Filename file's content will be send to
-- the server at address URL.
---------------------------------------
-- Keep-Alive client implementation --
---------------------------------------
type HTTP_Connection is limited private;
function Create
(Host : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Retry : Natural := Retry_Default;
Persistent : Boolean := True;
Timeouts : Timeouts_Values := No_Timeout;
Server_Push : Boolean := False;
Certificate : String := Default.Client_Certificate;
User_Agent : String := Default.User_Agent)
return HTTP_Connection;
procedure Create
(Connection : in out HTTP_Connection;
Host : String;
User : String := No_Data;
Pwd : String := No_Data;
Proxy : String := No_Data;
Proxy_User : String := No_Data;
Proxy_Pwd : String := No_Data;
Retry : Natural := Retry_Default;
Persistent : Boolean := True;
Timeouts : Timeouts_Values := No_Timeout;
Server_Push : Boolean := False;
SSL_Config : Net.SSL.Config := Net.SSL.Null_Config;
Certificate : String := Default.Client_Certificate;
User_Agent : String := Default.User_Agent);
-- Create a new connection. This is to be used with Keep-Alive client API
-- below. The connection will be tried Retry times if it fails. If
-- persistent is True the connection will remain open otherwise it will be
-- closed after each request. User/Pwd are the server authentication info,
-- Proxy is the name of the proxy server to use, Proxy_User/Proxy_Pwd are
-- the proxy authentication data. Only Basic authentication is supported
-- from this routine, for Digest authentication see below. Timeouts are
-- the send/receive timeouts for each request. If Server_Push is True the
-- connection will be used to push information to the client.
-- SSL_Config is to define secure connection configuration. Othewhise
-- Certificate can be set to specify the certificate filename to use for
-- the secure connection. User_Agent can be overridden to whatever you want
-- the client interface to present itself to the server.
function Get_Certificate
(Connection : HTTP_Connection) return AWS.Net.SSL.Certificate.Object;
-- Return the certificate used for the secure connection. If this is not a
-- secure connection, returns Net.SSL.Certificate.Undefined.
function Host (Connection : HTTP_Connection) return String;
-- Returns the host as recorded into the connection
procedure Set_WWW_Authentication
(Connection : in out HTTP_Connection;
User : String;
Pwd : String;
Mode : Authentication_Mode);
-- Sets the username password and authentication mode for the Web
-- authentication.
--
-- "Any" mean that user want to use Digest server authentication mode but
-- could use Basic if the server does not support Digest authentication.
--
-- "Basic" mean that client will send basic authentication. "Basic"
-- authentication is send with the first request and is a fast
-- authentication protocol.
--
-- "Digest" mean that the client ask for Digest authentication, it
-- requires that a first unauthorized request be sent to the server. The
-- server will answer "nonce" for the authentication protocol to continue.
procedure Set_Proxy_Authentication
(Connection : in out HTTP_Connection;
User : String;
Pwd : String;
Mode : Authentication_Mode);
-- Sets the username, password and authentication mode for the proxy
-- authentication.
procedure Set_Persistent
(Connection : in out HTTP_Connection; Value : Boolean) with Inline;
-- Change Persistent flag of the connection. If persistent is True the
-- connection will remain open, otherwise it will be closed after each
-- request, next request and further would be with "Connection: Close"
-- header line.
procedure Clear_SSL_Session (Connection : in out HTTP_Connection);
-- Avoid reuse SSL session data after reconnect
procedure Copy_Cookie
(Source : HTTP_Connection;
Destination : in out HTTP_Connection);
-- Copy a session Id from connection Source to connection Destination.
-- Allow both connections to share the same user environment. Note that
-- user's environment are thread-safe.
function Get_Cookie (Connection : HTTP_Connection) return String
with Inline;
-- Get the connection cookie
procedure Set_Cookie
(Connection : in out HTTP_Connection; Cookie : String) with Inline;
-- Set the connection cookie
function Cipher_Description (Connection : HTTP_Connection) return String;
function SSL_Session_Id (Connection : HTTP_Connection) return String;
-- Returns base64 encoded SSL session identifier.
-- Returns empty string for plain HTTP connections and for not connected
-- SSL HTTP connections.
function Read_Until
(Connection : HTTP_Connection;
Delimiter : String;
Wait : Boolean := True) return String;
-- Read data on the Connection until the delimiter (including the
-- delimiter). It can be used to retrieve the next piece of data from a
-- push server. If Wait is False the routine is looking for delimiter only
-- in the internal socket buffer and return empty string if no delimiter
-- found. If Wait is True and returned data is empty or does not termintate
-- with the delimiter the server push connection is closed.
procedure Read_Until
(Connection : in out HTTP_Connection;
Delimiter : String;
Result : in out Ada.Strings.Unbounded.Unbounded_String;
Wait : Boolean := True);
-- Idem as above but returns the result as an Unbounded_String
procedure Read_Some
(Connection : in out HTTP_Connection;
Data : out Ada.Streams.Stream_Element_Array;
Last : out Ada.Streams.Stream_Element_Offset);
-- Reads any available data from the client's connection.
-- If no data available, it will wait for some data to become available or
-- until it timeouts. Returns Last < Data'First when there is no data
-- available in the HTTP response. Connection have to be created with
-- parameter Server_Push => True.
procedure Read
(Connection : in out HTTP_Connection;
Data : out Ada.Streams.Stream_Element_Array;
Last : out Ada.Streams.Stream_Element_Offset);
-- Reads data from the client's connection until Data buffer if filled
-- or it reached the end of the response. Returns Last < Data'Last if
-- there is no more data available in HTTP response. Connection have
-- to be created with parameter Server_Push => True.
procedure Get
(Connection : in out HTTP_Connection;
Result : out Response.Data;
URI : String := No_Data;
Data_Range : Content_Range := No_Range;
Headers : Header_List := Empty_Header_List);
-- Same as Get above but using a Connection
procedure Head
(Connection : in out HTTP_Connection;
Result : out Response.Data;
URI : String := No_Data;
Headers : Header_List := Empty_Header_List);
-- Same as Head above but using a Connection
procedure Put
(Connection : in out HTTP_Connection;
Result : out Response.Data;
Data : String;
URI : String := No_Data;
Headers : Header_List := Empty_Header_List);
-- Same as Put above but using a Connection
procedure Put
(Connection : in out HTTP_Connection;
Result : out Response.Data;
Data : Stream_Element_Array;
URI : String := No_Data;
Headers : Header_List := Empty_Header_List);
procedure Post
(Connection : in out HTTP_Connection;
Result : out Response.Data;
Data : String;
Content_Type : String := No_Data;
URI : String := No_Data;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List);
-- Same as Post above but using a Connection
procedure Post
(Connection : in out HTTP_Connection;
Result : out Response.Data;
Data : Stream_Element_Array;
Content_Type : String := No_Data;
URI : String := No_Data;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List);
-- Same as Post above but using a Connection
procedure Upload
(Connection : in out HTTP_Connection;
Result : out Response.Data;
Filename : String;
URI : String := No_Data;
Headers : Header_List := Empty_Header_List;
Progress : access procedure
(Total, Sent : Stream_Element_Offset) := null);
-- Same as Upload above but using a Connection
procedure SOAP_Post
(Connection : HTTP_Connection;
Result : out Response.Data;
SOAPAction : String;
Data : String;
Streaming : Boolean := False;
Attachments : Attachment_List := Empty_Attachment_List;
Headers : Header_List := Empty_Header_List);
-- Same as SOAP_Post above but using a Connection
-- Streaming is to be able to parse response XML on the fly,
-- without intermediate buffer.
procedure Close (Connection : in out HTTP_Connection);
-- Close connection, it releases all associated resources
procedure Set_Streaming_Output
(Connection : in out HTTP_Connection;
Value : Boolean)
with Inline;
-- Call this routine with Value => True to be able to read data as a
-- stream by using Read and/or Read_Some routines above. Note that
-- Connection is already in Streaming mode if it has been created
-- with Server_Push => True.
procedure Set_Debug (On : Boolean);
-- Set debug mode on/off. If debug is activated the request header and the
-- server response header will be displayed.
private
use Ada;
use Ada.Strings.Unbounded;
Forever : constant Ada.Real_Time.Time_Span := Ada.Real_Time.Time_Span_Last;
type Timeouts_Values is record
Connect : Duration := Net.Forever;
Send : Duration := Net.Forever;
Receive : Duration := Net.Forever;
Response : Ada.Real_Time.Time_Span := Forever;
end record;
No_Timeout : constant Timeouts_Values :=
(Response => Forever, others => Net.Forever);
No_Data : constant String := "";
Undefined_Length : Response.Content_Length_Type
renames Response.Undefined_Length;
type HTTP_Connection_Access is access all HTTP_Connection;
type Authentication_Level is (WWW, Proxy);
type Authentication_Type is record
User : Unbounded_String;
Pwd : Unbounded_String;
-- Mode the user want to use
Init_Mode : Authentication_Mode := Any;
-- "Any" mean without authentication
Work_Mode : Authentication_Mode := Any;
Requested : Boolean := False;
-- Fields below are for digest authentication only
Realm : Unbounded_String;
Nonce : Unbounded_String;
QOP : Unbounded_String;
NC : Natural := 0;
end record;
type Authentication_Set is
array (Authentication_Level) of Authentication_Type;
type Auth_Attempts_Count is
array (Authentication_Level) of Natural range 0 .. 2;
type Transfer_Type is
(None, -- Connection is not in transfer state
Chunked, -- Transfer-encoding chunked
Content_Length, -- Content-Length defined
Until_Close, -- Document end on close socket
End_Response); -- Document is over
type HTTP_Connection is new Finalization.Limited_Controlled with record
Self : HTTP_Connection_Access := HTTP_Connection'Unchecked_Access;
Connect_URL : AWS.URL.Object;
Host : Unbounded_String;
Host_URL : AWS.URL.Object;
Proxy : Unbounded_String;
Proxy_URL : AWS.URL.Object;
Auth : Authentication_Set;
Opened : Boolean := False;
Persistent : Boolean;
Streaming : Boolean;
Cookie : Unbounded_String;
Socket : Net.Socket_Access;
SSL_Session : Net.SSL.Session_Type;
Retry : Natural;
Timeouts : Timeouts_Values;
Data_Range : Content_Range;
Certificate : Unbounded_String;
User_Agent : Unbounded_String;
SSL_Config : AWS.Net.SSL.Config;
Default_SSL_Config : Boolean := False;
Length : Response.Content_Length_Type := Undefined_Length;
Transfer : Transfer_Type := None;
Decode_Filter : ZLib.Filter_Type;
Decode_Buffer : Utils.Stream_Element_Array_Access;
Decode_First : Stream_Element_Offset;
Decode_Last : Stream_Element_Offset;
end record;
overriding procedure Finalize (Connection : in out HTTP_Connection);
procedure Debug_Message (Prefix, Message : String) with Inline;
-- Output Message prefixed with Prefix if Debug_On is True and does
-- nothing otherwise.
procedure Debug_Exception (E : Ada.Exceptions.Exception_Occurrence)
with Inline;
-- Output E exception if Debug_On is True and does nothing otherwise
procedure Error_Processing
(Connection : in out HTTP_Connection;
Try_Count : in out Natural;
Result : out Response.Data;
Context : String;
E : Ada.Exceptions.Exception_Occurrence;
Stamp : Ada.Real_Time.Time);
-- Check timeout and Try_Count and set error responce into Result
-- if necessary.
end AWS.Client;
|