docs: adding open source required documents (#34)

gavinbarron · web-flow · commit d47c9507814b · 2022-11-17T11:16:14.000+01:00
* docs: adding open source required documents

* adding trademarks section to readme

* formatting fixes and improved contribution information

* adding copyright headers and moving markdown files to root
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing to the Microsoft Developer Proxy
+
+The best way to contribute initially is to download and try the Microsoft Graph Developer Proxy and then give us your feedback, both positive and negative, this will help us shape the future direction of this tool. At present we are not accepting community code contributions but will be opening up to accept pull requests in the future.
+
+## Our foundation
+
+The Microsoft Graph Developer Proxy is built with .NET 6 and uses the [Titanium.Web.Proxy](https://github.com/justcoding121/titanium-web-proxy).
+
+## Reporting issues and suggesting new features
+
+Please use [GitHub Issues](https://github.com/microsoftgraph/msgraph-developer-proxy/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) for bug reports and feature request.
+
+We highly recommend you browse existing issues first.
+
+## Contributing to the project
+
+We will be opening up to accept code contributions in the future, however at present this project is source open.
+
+> NOTE: When we start accepting community code contributions a signed a contribution license agreement will be required for all contributions and will be checked automatically on new pull requests. You will be asked to read and sign the agreement https://cla.microsoft.com/ after submitting a request to this repository.
+
+## Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ You can test your existing applications without any changes, even if you don't h
 
 To install the proxy is easy
 
-- Download the latest version of the ZIP file for your operating system from the [Releases](https://github.com/microsoftgraph/msgraph-developer-proxy/releases) page 
+- Download the latest version of the ZIP file for your operating system from the [Releases](https://github.com/microsoftgraph/msgraph-developer-proxy/releases) page
 - Extract the archive to a folder of your choice
 
 Graph Developer Proxy doesn't need an installation and you can run it from any location on your machine.
@@ -382,3 +382,11 @@ As documented in the [Best practices to handle throttling](https://learn.microso
 ### All requests fail with gateway timeout
 
 If you're running the proxy for the first time, it can happen that the network access configuration didn't propagate timely and the proxy started without access to your network. Close the proxy by pressing Enter in proxy's window and restart the proxy and it should be working as intended.
+
+## A Microsoft Hackathon 2022 Project
+
+The initial build of this project was completed in the week of 5-9 September 2022 by Waldek Mastykarz, Gavin Barron and Garry Trinder
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->
diff --git a/THIRD PARTY NOTICES b/THIRD PARTY NOTICES
@@ -0,0 +1,27 @@
+This file is based on or incorporates material from the projects listed below (Third Party OSS). The original copyright notice and the license under which Microsoft received such Third Party OSS, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party OSS to you under the licensing terms for the Microsoft product or service. Microsoft
+reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
+
+Titanium.Web.Proxy - <= 3.2.0
+Copyright (c) 2015 titanium007
+
+Provided for Informational Purposes Only
+
+MIT License
+
+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.
diff --git a/msgraph-developer-proxy/ChaosEngine.cs b/msgraph-developer-proxy/ChaosEngine.cs
@@ -1,4 +1,7 @@
-﻿using System.Net;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Net;
 using System.Security.Cryptography.X509Certificates;
 using System.Text.Json;
 using System.Text.RegularExpressions;
@@ -204,8 +207,8 @@ async Task OnRequest(object sender, SessionEventArgs e) {
                 string bodyString = await e.GetRequestBodyAsString();
                 e.SetRequestBodyString(bodyString);
 
-                // store request 
-                // so that you can find it from response handler 
+                // store request
+                // so that you can find it from response handler
                 e.UserData = e.HttpClient.Request;
             }
 
@@ -358,7 +361,7 @@ private void UpdateProxyResponse(SessionEventArgs e, ResponseComponents response
             e.GenericResponse(responseComponents.Body ?? string.Empty, responseComponents.ErrorStatus, responseComponents.Headers);
         }
 
-        private string BuildApiErrorMessage(Request r) => $"Some error was generated by the proxy. {(IsSdkRequest(r) ? "" : BuildUseSdkMessage(r))}";  
+        private string BuildApiErrorMessage(Request r) => $"Some error was generated by the proxy. {(IsSdkRequest(r) ? "" : BuildUseSdkMessage(r))}";
 
         private string BuildThrottleKey(Request r) => $"{r.Method}-{r.Url}";
 
diff --git a/msgraph-developer-proxy/ErrorResponseBody.cs b/msgraph-developer-proxy/ErrorResponseBody.cs
@@ -1,4 +1,7 @@
-﻿using System.Text.Json.Serialization;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Text.Json.Serialization;
 
 namespace Microsoft.Graph.DeveloperProxy {
     internal class ErrorResponseBody {
diff --git a/msgraph-developer-proxy/Program.cs b/msgraph-developer-proxy/Program.cs
@@ -1,4 +1,7 @@
-﻿using Microsoft.Graph.DeveloperProxy;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.Graph.DeveloperProxy;
 using System.CommandLine;
 
 return await new ProxyHost().GetRootCommand().InvokeAsync(args);
diff --git a/msgraph-developer-proxy/ProxyCommandHandler.cs b/msgraph-developer-proxy/ProxyCommandHandler.cs
@@ -1,4 +1,7 @@
-﻿using Microsoft.Extensions.Configuration;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Configuration;
 using System.CommandLine;
 using System.CommandLine.Invocation;
 using System.Text.Json;
@@ -47,7 +50,7 @@ public async Task<int> InvokeAsync(InvocationContext context) {
                 Console.Error.WriteLine();
                 Console.ForegroundColor = originalColor;
             }
-            
+
             try {
                 await new ChaosEngine(Configuration).Run(cancellationToken);
                 return 0;
diff --git a/msgraph-developer-proxy/ProxyConfiguration.cs b/msgraph-developer-proxy/ProxyConfiguration.cs
@@ -1,4 +1,7 @@
-﻿using System.Text.Json;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Microsoft.Graph.DeveloperProxy {
diff --git a/msgraph-developer-proxy/ProxyHost.cs b/msgraph-developer-proxy/ProxyHost.cs
@@ -1,4 +1,7 @@
-﻿using System.CommandLine;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.CommandLine;
 
 namespace Microsoft.Graph.DeveloperProxy {
     internal class ProxyHost {
@@ -9,7 +12,7 @@ public RootCommand GetRootCommand() {
             portOption.AddAlias("-p");
             portOption.ArgumentHelpName = "port";
             portOption.SetDefaultValue(8000);
-            
+
             var rateOption = new Option<int>("--failure-rate", "The percentage of requests to graph to respond with failures");
             rateOption.AddAlias("-f");
             rateOption.ArgumentHelpName = "failure rate";
@@ -47,7 +50,7 @@ public RootCommand GetRootCommand() {
             };
             command.Description = "HTTP proxy to create random failures for calls to Microsoft Graph";
             command.Handler = new ProxyCommandHandler(portOption, rateOption, noMocksOptions, cloudOption, allowedErrorsOption);
-            
+
             return command;
         }
     }
diff --git a/msgraph-developer-proxy/UpdateNotification.cs b/msgraph-developer-proxy/UpdateNotification.cs
@@ -1,4 +1,7 @@
-﻿using System;
+﻿// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
diff --git a/samples/index.html b/samples/index.html
@@ -1,3 +1,6 @@
+<!-- Copyright (c) Microsoft Corporation.
+     Licensed under the MIT License. -->
+
 <html lang="en">
 
 <head>
diff --git a/samples/nosdk.html b/samples/nosdk.html
@@ -1,3 +1,6 @@
+<!-- Copyright (c) Microsoft Corporation.
+     Licensed under the MIT License. -->
+
 <html lang="en">
 
 <head>
diff --git a/samples/withsdk.html b/samples/withsdk.html
@@ -1,3 +1,6 @@
+<!-- Copyright (c) Microsoft Corporation.
+     Licensed under the MIT License. -->
+
 <html lang="en">
 
 <head>
