Skip to content

Commit

Permalink
Ticket #4 : Add WPF client
Browse files Browse the repository at this point in the history
  • Loading branch information
thabart committed Nov 14, 2019
1 parent fa53a88 commit 82b3cac
Show file tree
Hide file tree
Showing 56 changed files with 2,862 additions and 95 deletions.
11 changes: 9 additions & 2 deletions DnsServer.sln
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.28307.645
# Visual Studio Version 16
VisualStudioVersion = 16.0.29503.13
MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "01. Core Layer", "01. Core Layer", "{F78A8B31-336A-4688-A854-5F74E5ACC14D}"
EndProject
Expand All @@ -20,6 +20,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
Directory.Build.props = Directory.Build.props
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DnsServer.WpfClient", "src\DnsServer.WpfClient\DnsServer.WpfClient.csproj", "{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -38,6 +40,10 @@ Global
{66EF4897-6A24-45D8-A8FF-354526A658FD}.Debug|Any CPU.Build.0 = Debug|Any CPU
{66EF4897-6A24-45D8-A8FF-354526A658FD}.Release|Any CPU.ActiveCfg = Release|Any CPU
{66EF4897-6A24-45D8-A8FF-354526A658FD}.Release|Any CPU.Build.0 = Release|Any CPU
{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -46,6 +52,7 @@ Global
{DA5C6A98-52EB-48AA-B616-C4010C222D36} = {F78A8B31-336A-4688-A854-5F74E5ACC14D}
{B9EE88CB-79B0-4733-82A9-4F45306E3EF0} = {99C091AE-BDDC-4099-B953-61CB77819816}
{66EF4897-6A24-45D8-A8FF-354526A658FD} = {F0A96A7D-E821-43CD-B7EB-CB5BFFAA1F5A}
{C6F08D20-A313-44AE-AAE5-BFF43B86D8E3} = {99C091AE-BDDC-4099-B953-61CB77819816}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {98B39694-18F2-478E-8932-3B25448E485D}
Expand Down
8 changes: 8 additions & 0 deletions NuGet.Config
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="sid" value="https://www.myget.org/F/advance-ict/api/v3/index.json" />
</packageSources>
</configuration>
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
[![Build status](https://ci.appveyor.com/api/projects/status/sr0ee1m56dvgv2d0?svg=true)](https://ci.appveyor.com/project/simpleidserver/dnsserver)
[![MyGet (dev)](https://img.shields.io/myget/advance-ict/v/DnsServer.svg)](http://myget.org/gallery/advance-ict)

DnsServer is an open source library enabling any DOTNET CORE applications to host a DNS server.
The project implements the RFC `1034`_ and `1035`_.

For project documentation, please visit [readthedocs](https://dnsserver.readthedocs.io/en/latest/).

## Packages

| | | | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------------------- |
| `DnsServer` | [![MyGet (dev)](https://img.shields.io/myget/advance-ict/v/DnsServer.svg)](https://www.myget.org/feed/advance-ict/package/nuget/DnsServer) | [![NuGet](https://img.shields.io/nuget/v/DnsServer.svg)](https://nuget.org/packages/DnsServer) | [![NuGet](https://img.shields.io/nuget/dt/DnsServer.svg)](https://nuget.org/packages/DnsServer) |


## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
174 changes: 174 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = u'SimpleIdServer'
copyright = u'2019, SimpleIdServer'
author = u'SimpleIdServer'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u''


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx_rtd_theme"
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'SimpleIdServerdoc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'SimpleIdServer.tex', u'SimpleIdServer Documentation',
u'SimpleIdServer', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'simpleidserver', u'SimpleIdServer Documentation',
[author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'SimpleIdServer', u'SimpleIdServer Documentation',
author, 'SimpleIdServer', 'One line description of project.',
'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
26 changes: 26 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Welcome to DnsServer
====================

DnsServer is an open source library enabling any DOTNET CORE applications to host a DNS server.
The project implements the RFC `1034`_ and `1035`_.

Github: https://github.com/simpleidserver/DnsServer

Nuget feed: https://www.myget.org/F/advance-ict/api/v3/index.json

.. toctree::
:maxdepth: 3
:hidden:
:caption: Getting started

intro/getting-started-dns

.. toctree::
:maxdepth: 3
:hidden:
:caption: Reference

reference/dnsserveroptions

.. _1034: https://tools.ietf.org/rfc/rfc1034.txt
.. _1035: https://tools.ietf.org/rfc/rfc1035.txt
80 changes: 80 additions & 0 deletions docs/intro/getting-started-dns.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
How to setup an DNS server ?
============================

A DNS server can be hosted in any DOTNET CORE project like ASP.NET CORE or Console application.
Follow the steps below to deploy a DNS server into a console application :

1) Create an empty Console application.

2) Install the Nuget package **DnsServer**.

3) In the Program.cs file, insert the following line into the **Main** method :

var dnsServer = new DnsServerHostBuilder(o =>
{
o.ExcludeForwardRequests.Add(new Regex("^.*example\\.com$"));
o.ExcludeForwardRequests.Add(new Regex("^.*in-addr\\.arpa$"));
})
.AddDNSZones(new List<DNSZone>
{
new DNSZone("example.com")
{
ResourceRecords = new List<ResourceRecord>
{
new AResourceRecord(3600)
{
Address = "127.0.0.1"
},
new AResourceRecord(3600, "www")
{
Address = "127.0.0.1"
},
new AResourceRecord(3600, "ns1")
{
Address = "127.0.0.1"
},
new SOAResourceRecord(3600)
{
MName = "ns1.example.com",
RName = "admin.example.com",
Serial = 5,
Refresh = 604800,
Expire = 2419200,
Minimum = 604800,
Retry = 86400
},
new NSResourceRecord(3600)
{
NSDName = "ns1.example.com"
}
}
},
new DNSZone("1.0.0.127.in-addr.arpa")
{
ResourceRecords = new List<ResourceRecord>
{
new PTRResourceRecord(100)
{
PTRDNAME = "localhost"
}
}
}
})
.AddDNSRootServers(DnsServerConstants.DefaultRootServers)
.Build();
dnsServer.Run();

4) Configure the network interface to use the local DNS server.

5) Open a command prompt and execute **ping www.example.com**.

The **DnsServerHostBuilder** class accepts in its constructor a callback which can be used by developers to change the options of the DNS server.
There are several operations exposed by the **DnsServerHostBuilder** class :

- **AddDNSZones** : Configure DNS zones.

- **AddDNSRootServers** : Configure the DNS root servers.

A WPF client also exists `here`_.

.. _here: https://github.com/simpleidserver/DnsServer/tree/master/src/DnsServer.WpfClient
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd

0 comments on commit 82b3cac

Please sign in to comment.