Class: Savon::WSSE

Inherits:
Object show all
Defined in:
lib/savon/wsse.rb

Overview

Savon::WSSE

Represents parameters for WSSE authentication.

Constant Summary collapse

BaseAddress =

Base address for WSSE docs.

"http://docs.oasis-open.org/wss/2004/01"
WSENamespace =

Namespace for WS Security Secext.

"#{BaseAddress}/oasis-200401-wss-wssecurity-secext-1.0.xsd"
WSUNamespace =

Namespace for WS Security Utility.

"#{BaseAddress}/oasis-200401-wss-wssecurity-utility-1.0.xsd"
PasswordTextURI =

URI for “wsse:Password/@Type” #PasswordText.

"#{BaseAddress}/oasis-200401-wss-username-token-profile-1.0#PasswordText"
PasswordDigestURI =

URI for “wsse:Password/@Type” #PasswordDigest.

"#{BaseAddress}/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
@@username =

Global WSSE username.

nil
@@password =

Global WSSE password.

nil
@@digest =

Global setting of whether to use WSSE digest.

false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#digest=(value) ⇒ Object (writeonly)

Sets whether to use WSSE digest per request.



83
84
85
 
# File 'lib/savon/wsse.rb', line 83

def digest=(value)
  @digest = value
end

Class Method Details

.digest=(digest) ⇒ Object

Global setting of whether to use WSSE digest.



58
59
60
 
# File 'lib/savon/wsse.rb', line 58

def self.digest=(digest)
  @@digest = digest
end

.digest? ⇒ Boolean

Returns the global setting of whether to use WSSE digest.

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/savon/wsse.rb', line 53

def self.digest?
  @@digest
end

.password ⇒ Object

Returns the global WSSE password.



40
41
42
 
# File 'lib/savon/wsse.rb', line 40

def self.password
  @@password
end

.password=(password) ⇒ Object

Sets the global WSSE password.



45
46
47
 
# File 'lib/savon/wsse.rb', line 45

def self.password=(password)
  @@password = password.nil? ? nil : password.to_s
end

.username ⇒ Object

Returns the global WSSE username.



27
28
29
 
# File 'lib/savon/wsse.rb', line 27

def self.username
  @@username
end

.username=(username) ⇒ Object

Sets the global WSSE username.



32
33
34
 
# File 'lib/savon/wsse.rb', line 32

def self.username=(username)
  @@username = username.nil? ? nil : username.to_s
end

Instance Method Details

#digest? ⇒ Boolean

Returns whether to use WSSE digest. Defaults to the global setting.

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/savon/wsse.rb', line 86

def digest?
  @digest || self.class.digest?
end

#header ⇒ Object

Returns the XML for a WSSE header or an empty String unless both username and password were specified.



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/savon/wsse.rb', line 92

def header
  return "" unless username && password

  builder = Builder::XmlMarkup.new
  builder.wsse :Security, "xmlns:wsse" => WSENamespace do |xml|
    xml.wsse :UsernameToken, "xmlns:wsu" => WSUNamespace do
      xml.wsse :Username, username
      xml.wsse :Nonce, nonce
      xml.wsu :Created, timestamp
      xml.wsse :Password, password_node, :Type => password_type
    end
  end
end

#password ⇒ Object

Returns the WSSE password. Defaults to the global setting.



78
79
80
 
# File 'lib/savon/wsse.rb', line 78

def password
  @password || self.class.password
end

#password=(password) ⇒ Object

Sets the WSSE password per request.



73
74
75
 
# File 'lib/savon/wsse.rb', line 73

def password=(password)
  @password = password.nil? ? nil : password.to_s
end

#username ⇒ Object

Returns the WSSE username. Defaults to the global setting.



68
69
70
 
# File 'lib/savon/wsse.rb', line 68

def username
  @username || self.class.username
end

#username=(username) ⇒ Object

Sets the WSSE username per request.



63
64
65
 
# File 'lib/savon/wsse.rb', line 63

def username=(username)
  @username = username.nil? ? nil : username.to_s
end