netconf/callhome-protocol/src/main/java/org/opendaylight/netconf/callhome/protocol/CallHomeAuthorizationProvider.java

   1 /*
   2  * Copyright (c) 2016 Brocade Communication Systems and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.callhome.protocol;
   9
  10 import java.net.SocketAddress;
  11 import java.security.PublicKey;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * Provider responsible for resolving CallHomeAuthorization.
  16  */
  17 public interface CallHomeAuthorizationProvider {
  18
  19     /**
  20      * Provides authorization parameters for incoming call-home connection.
  21      *
  22      * @param remoteAddress Remote socket address of incoming connection
  23      * @param serverKey     SSH key provided by SSH server on incoming connection
  24      * @return {@link CallHomeAuthorization} with authorization information.
  25      */
  26     @Nonnull
  27     CallHomeAuthorization provideAuth(@Nonnull SocketAddress remoteAddress, @Nonnull PublicKey serverKey);
  28
  29 }