1 files changed, 90 insertions, 0 deletions
diff --git a/src/config/mod.rs b/src/config/mod.rs
new file mode 100644
index 0000000..0cd8742
--- /dev/null
+++ b/src/config/mod.rs
@@ -0,0 +1,90 @@
+// Copyright 2017-2018 int08h LLC
+//
+// Licensed 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.
+
+//!
+//! Ways to configure the Roughenough server.
+//!
+//! The [ServerConfig](trait.ServerConfig.html) trait specifies the required and optional
+//! parameters available for configuring a Roughenoguh server instance.
+//!
+//! Implementations of `ServerConfig` obtain configurations from different back-end sources.
+//!
+
+extern crate hex;
+
+use std::net::SocketAddr;
+use std::time::Duration;
+
+mod file;
+pub use self::file::FileConfig;
+
+mod environment;
+pub use self::environment::EnvironmentConfig;
+
+use Error;
+
+/// Maximum number of requests to process in one batch and include the the Merkle tree.
+pub const DEFAULT_BATCH_SIZE: u8 = 64;
+
+/// Amount of time between each logged status update.
+pub const DEFAULT_STATUS_INTERVAL: Duration = Duration::from_secs(600);
+
+///
+/// Specifies parameters needed to configure a Roughenough server.
+///
+/// Parameters labeled "**Required**" must are always be provided and have no default value.
+/// Parameters labeled "**Optional**" provide default values that can be overridden.
+///
+/// * **`interface`** - [Required] IP address or interface name for listening to client requests
+/// * **`port`** - [Required] UDP port to listen for requests
+/// * **`seed`** - [Required] A 32-byte hexadecimal value used to generate the server's long-term
+///                key pair. **This is a secret value and must be un-guessable**,
+///                treat it with care.
+/// * **`batch_size`** - [Optional] The maximum number of requests to process in one batch. All
+///                      nonces in a batch are used to build a Merkle tree, the root of which
+///                      is signed.
+///                      Defaults to [DEFAULT_BATCH_SIZE](constant.DEFAULT_BATCH_SIZE.html)
+/// * **`status_interval`** - [Optional] Amount of time between each logged status update.
+///                           Defaults to [DEFAULT_STATUS_INTERVAL](constant.DEFAULT_STATUS_INTERVAL.html)
+///
+/// Implementations of this trait obtain a valid configuration from different back-
+/// end sources.
+///
+/// See:
+///   * [FileConfig](struct.FileConfig.html)
+///
+pub trait ServerConfig {
+    /// [Required] IP address or interface name to listen for client requests
+    fn interface(&self) -> &str;
+
+    /// [Required] UDP port to listen for requests
+    fn port(&self) -> u16;
+
+    /// [Required] A 32-byte hexadecimal value used to generate the server's
+    /// long-term key pair. **This is a secret value and must be un-guessable**,
+    /// treat it with care.
+    fn seed(&self) -> &[u8];
+
+    /// [Optional] The maximum number of requests to process in one batch. All
+    /// nonces in a batch are used to build a Merkle tree, the root of which is signed.
+    /// Defaults to [DEFAULT_BATCH_SIZE](constant.DEFAULT_BATCH_SIZE.html)
+    fn batch_size(&self) -> u8;
+
+    /// [Optional] Amount of time between each logged status update.
+    /// Defaults to [DEFAULT_STATUS_INTERVAL](constant.DEFAULT_STATUS_INTERVAL.html)
+    fn status_interval(&self) -> Duration;
+
+    /// Convenience function to create a `SocketAddr` from the provided `interface` and `port`
+    fn socket_addr(&self) -> Result<SocketAddr, Error>;
+}