tls: add address(), remoteAddress/remotePort

Fixes #758. Fixes #1055.
nodejs · Oct 26, 2011 · cbcaeed · cbcaeed
1 parent 0e8a55d
commit cbcaeed
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 0 deletions.
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
@@ -251,6 +251,12 @@ Stops the server from accepting new connections. This function is
 asynchronous, the server is finally closed when the server emits a `'close'`
 event.
 
+#### server.address()
+
+Returns the bound address and port of the server as reported by the operating
+system.
+See [net.Server.address()](net.html#server.address) for more information.
+
 #### server.addContext(hostname, credentials)
 
 Add secure context that will be used if client request's SNI hostname is
@@ -324,3 +330,18 @@ Example:
 
 If the peer does not provide a certificate, it returns `null` or an empty
 object.
+
+#### cleartextStream.address()
+
+Returns the bound address and port of the underlying socket as reported by the
+operating system. Returns an object with two properties, e.g.
+`{"address":"192.168.57.1", "port":62053}`
+
+#### cleartextStream.remoteAddress
+
+The string representation of the remote IP address. For example,
+`'74.125.127.100'` or `'2001:4860:a005::68'`.
+
+#### cleartextStream.remotePort
+
+The numeric representation of the remote port. For example, `443`.
diff --git a/lib/tls.js b/lib/tls.js
@@ -490,6 +490,19 @@ CleartextStream.prototype._pusher = function(pool, offset, length) {
   return this.pair.ssl.clearOut(pool, offset, length);
 };
 
+CleartextStream.prototype.address = function() {
+  return this.socket && this.socket.address();
+};
+
+CleartextStream.prototype.__defineGetter__('remoteAddress', function() {
+  return this.socket && this.socket.remoteAddress;
+});
+
+
+CleartextStream.prototype.__defineGetter__('remotePort', function() {
+  return this.socket && this.socket.remotePort;
+});
+
 
 function EncryptedStream(pair) {
   CryptoStream.call(this, pair);

diff --git a/test/simple/test-tls-remote.js b/test/simple/test-tls-remote.js
@@ -0,0 +1,61 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+if (!process.versions.openssl) {
+  console.error('Skipping because node compiled without OpenSSL.');
+  process.exit(0);
+}
+
+var common = require('../common');
+var assert = require('assert');
+var tls = require('tls');
+var fs = require('fs');
+var path = require('path');
+
+var options = {
+  key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')),
+  cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem'))
+};
+
+var server = tls.Server(options, function(s) {
+  assert.equal(s.address().address, s.socket.address().address);
+  assert.equal(s.address().port, s.socket.address().port);
+
+  assert.equal(s.remoteAddress, s.socket.remoteAddress);
+  assert.equal(s.remotePort, s.socket.remotePort);
+  s.end();
+});
+
+server.listen(common.PORT, '127.0.0.1', function() {
+  assert.equal(server.address().address, '127.0.0.1');
+  assert.equal(server.address().port, common.PORT);
+
+  var c = tls.connect(common.PORT, '127.0.0.1', function() {
+    assert.equal(c.address().address, c.socket.address().address);
+    assert.equal(c.address().port, c.socket.address().port);
+
+    assert.equal(c.remoteAddress, '127.0.0.1');
+    assert.equal(c.remotePort, common.PORT);
+  });
+  c.on('end', function() {
+    server.close();
+  });
+});