Class: Win32::SSPI::SSPIResult

Inherits:

Object

• Object
• Win32::SSPI::SSPIResult

Defined in:

win32/lib/win32/sspi.rb

Overview

Takes a return result from an SSPI function and interprets the value.

Constant Summary

SEC_E_OK =

Good results

0x00000000

SEC_I_CONTINUE_NEEDED =

0x00090312

SEC_E_INSUFFICIENT_MEMORY =

These are generally returned by InitializeSecurityContext

0x80090300

SEC_E_INTERNAL_ERROR =

0x80090304

SEC_E_INVALID_HANDLE =

0x80090301

SEC_E_INVALID_TOKEN =

0x80090308

SEC_E_LOGON_DENIED =

0x8009030C

SEC_E_NO_AUTHENTICATING_AUTHORITY =

0x80090311

SEC_E_NO_CREDENTIALS =

0x8009030E

SEC_E_TARGET_UNKNOWN =

0x80090303

SEC_E_UNSUPPORTED_FUNCTION =

0x80090302

SEC_E_WRONG_PRINCIPAL =

0x80090322

SEC_E_NOT_OWNER =

These are generally returned by AcquireCredentialsHandle

0x80090306

SEC_E_SECPKG_NOT_FOUND =

0x80090305

SEC_E_UNKNOWN_CREDENTIALS =

0x8009030D

@@map =

{}

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Instance Method Summary

• #==(other) ⇒ Object
• #initialize(value) ⇒ SSPIResult constructor

  A new instance of SSPIResult.

• #ok? ⇒ Boolean
• #to_s ⇒ Object

Constructor Details

#initialize(value) ⇒ SSPIResult

Returns a new instance of SSPIResult.

# File 'win32/lib/win32/sspi.rb', line 181

def initialize(value)
	# convert to unsigned long
	value = [value].pack("L").unpack("L").first
	raise "#{value.to_s(16)} is not a recognized result" unless @@map.has_key? value
	@value = value
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value

# File 'win32/lib/win32/sspi.rb', line 179

def value
  @value
end

Instance Method Details

#==(other) ⇒ Object

# File 'win32/lib/win32/sspi.rb', line 196

def ==(other)
	if other.is_a?(SSPIResult)
		@value == other.value
	elsif other.is_a?(Fixnum)
		@value == @@map[other]
	else
		false
	end
end

#ok? ⇒ Boolean

Returns:

• (Boolean)

# File 'win32/lib/win32/sspi.rb', line 192

def ok?
	@value == SEC_I_CONTINUE_NEEDED || @value == SEC_E_OK
end

#to_s ⇒ Object

# File 'win32/lib/win32/sspi.rb', line 188

def to_s
	@@map[@value].to_s
end