You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by mc...@apache.org on 2015/06/03 22:31:05 UTC
[28/34] qpid-proton git commit: PROTON-799: Added the SASL class to
the Ruby engine APIs.
PROTON-799: Added the SASL class to the Ruby engine APIs.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/152129ad
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/152129ad
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/152129ad
Branch: refs/heads/master
Commit: 152129ad3bdc51d21412d2fc2f2c99ca7bb036b1
Parents: 8f38c7a
Author: Darryl L. Pierce <mc...@gmail.com>
Authored: Tue Jan 20 16:09:30 2015 -0500
Committer: Darryl L. Pierce <mc...@gmail.com>
Committed: Wed Jun 3 16:29:24 2015 -0400
----------------------------------------------------------------------
proton-c/bindings/ruby/lib/core/sasl.rb | 94 ++++++++++++++++++++++++++
proton-c/bindings/ruby/lib/qpid_proton.rb | 1 +
2 files changed, 95 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/152129ad/proton-c/bindings/ruby/lib/core/sasl.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/sasl.rb b/proton-c/bindings/ruby/lib/core/sasl.rb
new file mode 100644
index 0000000..7870652
--- /dev/null
+++ b/proton-c/bindings/ruby/lib/core/sasl.rb
@@ -0,0 +1,94 @@
+#--
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#++
+
+module Qpid::Proton
+
+ # The SASL layer is responsible for establishing an authenticated and/or
+ # encrypted tunnel over which AMQP frames are passed between peers.
+ #
+ # The peer acting as the SASL client must provide authentication
+ # credentials.
+ #
+ # The peer acting as the SASL server must provide authentication against the
+ # received credentials.
+ #
+ # @example
+ # # SCENARIO: the remote endpoint has not initialized their connection
+ # # then the local endpoint, acting as a SASL server, decides
+ # # to allow an anonymous connection.
+ # #
+ # # The SASL layer locally assumes the role of server and then
+ # # enables anonymous authentication for the remote endpoint.
+ # #
+ # sasl = @transport.sasl
+ # sasl.server
+ # sasl.mechanisms("ANONYMOUS")
+ # sasl.done(Qpid::Proton::SASL::OK)
+ #
+ class SASL
+
+ # Negotation has not completed.
+ NONE = Cproton::PN_SASL_NONE
+ # Authentication succeeded.
+ OK = Cproton::PN_SASL_OK
+ # Authentication failed due to bad credentials.
+ AUTH = Cproton::PN_SASL_AUTH
+
+ # Constructs a new instance for the given transport.
+ #
+ # @param transport [Transport] The transport.
+ #
+ # @private A SASL should be fetched only from its Transport
+ #
+ def initialize(transport)
+ @impl = Cproton.pn_sasl(transport.impl)
+ end
+
+ # Sets the acceptable SASL mechanisms.
+ #
+ # @param mechanisms [String] The space-delimited set of mechanisms.
+ #
+ # @example Use anonymous SASL authentication.
+ # @sasl.mechanisms("GSSAPI CRAM-MD5 PLAIN")
+ #
+ def mechanisms(mechanisms)
+ Cproton.pn_sasl_mechanisms(@impl, mechanisms)
+ end
+
+ # Returns the outcome of the SASL negotiation.
+ #
+ # @return [Fixnum] The outcome.
+ #
+ def outcome
+ outcome = Cprotn.pn_sasl_outcome(@impl)
+ return nil if outcome == NONE
+ outcome
+ end
+
+ # Set the condition of the SASL negotiation.
+ #
+ # @param outcome [Fixnum] The outcome.
+ #
+ def done(outcome)
+ Cproton.pn_sasl_done(@impl, outcome)
+ end
+
+ end
+
+end
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/152129ad/proton-c/bindings/ruby/lib/qpid_proton.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton.rb b/proton-c/bindings/ruby/lib/qpid_proton.rb
index 2a57b32..3ac0b9e 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton.rb
@@ -63,6 +63,7 @@ require "core/link"
require "core/sender"
require "core/receiver"
require "core/connection"
+require "core/sasl"
# Messenger API classes
require "messenger/filters"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org