Git Product home page Git Product logo

shtem's Introduction

Shtem

Shtem is a PHP based application which serves its function as a "short term memory". It means that Shtem will be accepting a "memory" input in form of HTTP request and then saves it inside the server for a short period of time.

What are the intended use cases?

There is actually no "intended" use case. Shtem could be used in a variety of functions. For example, Shtem could be used when performing a RCE exploitation where the output must be reflected to a remote server. It is very useful when you don't have a server connected to the internet.

How to use it?

After you have deployed Shtem, you could use it by contacting its API endpoint from a script or by contacting it directly from a web browser. A hosted version of Shtem is available here (please note that there is no uptime guarantee).

Installation

Prerequisites

Shtem requires a web server that supports PHP (e.g. Apache, Nginx, etc.). In some cases, PHP Development Server could also be used in development environment. For servers other than Apache, you may need to create an additional file equivalent to the .htaccess file.

Configuration

Shtem configuration could be done by editing config.php file. In some cases, base_uri is the only thing that needs to be changed. If you're going to use Apache, make sure that the usage of .htaccess is allowed.

Deployment

In an Apache web server, you just need to copy all of the files into the web directory. For use with PHP Development Server, use router.php as a router by running php -S host:port router.php command.

API Documentation

All of these endpoints will respond in JSON format.

Endpoint Method Description Example
/<mname> GET/POST Store a memory item named <mname>. A valid <mname> consists of lowercase and numerics (a-z0-9). It is not necessary to set <mname>. If <mname> is not set, the default value is the remote or the IP address. For example, if the remote address is 192.168.1.1 then the <mname> will be 19216811. /foo, /bar, /baz
/get/<mname> GET Get a memory item named <mname> if it exists. /get/foo, /get/bar, /get/baz

Contribution

I am new to PHP development, can't guarantee that everything works flawlessly. Feel free to open a pull request or an issue. Any kind of contribution is highly appreciated.

License

Shtem is licensed with MIT License.

shtem's People

Contributors

lc-at avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.